perf tools: Don't clone maps from parent when synthesizing forks
[linux/fpc-iii.git] / drivers / scsi / sd.c
blob3bb2b3351e35e6fbef7f424e79954abddcf573de
1 /*
2 * sd.c Copyright (C) 1992 Drew Eckhardt
3 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
5 * Linux scsi disk driver
6 * Initial versions: Drew Eckhardt
7 * Subsequent revisions: Eric Youngdale
8 * Modification history:
9 * - Drew Eckhardt <drew@colorado.edu> original
10 * - Eric Youngdale <eric@andante.org> add scatter-gather, multiple
11 * outstanding request, and other enhancements.
12 * Support loadable low-level scsi drivers.
13 * - Jirka Hanika <geo@ff.cuni.cz> support more scsi disks using
14 * eight major numbers.
15 * - Richard Gooch <rgooch@atnf.csiro.au> support devfs.
16 * - Torben Mathiasen <tmm@image.dk> Resource allocation fixes in
17 * sd_init and cleanups.
18 * - Alex Davis <letmein@erols.com> Fix problem where partition info
19 * not being read in sd_open. Fix problem where removable media
20 * could be ejected after sd_open.
21 * - Douglas Gilbert <dgilbert@interlog.com> cleanup for lk 2.5.x
22 * - Badari Pulavarty <pbadari@us.ibm.com>, Matthew Wilcox
23 * <willy@debian.org>, Kurt Garloff <garloff@suse.de>:
24 * Support 32k/1M disks.
26 * Logging policy (needs CONFIG_SCSI_LOGGING defined):
27 * - setting up transfer: SCSI_LOG_HLQUEUE levels 1 and 2
28 * - end of transfer (bh + scsi_lib): SCSI_LOG_HLCOMPLETE level 1
29 * - entering sd_ioctl: SCSI_LOG_IOCTL level 1
30 * - entering other commands: SCSI_LOG_HLQUEUE level 3
31 * Note: when the logging level is set by the user, it must be greater
32 * than the level indicated above to trigger output.
35 #include <linux/module.h>
36 #include <linux/fs.h>
37 #include <linux/kernel.h>
38 #include <linux/mm.h>
39 #include <linux/bio.h>
40 #include <linux/genhd.h>
41 #include <linux/hdreg.h>
42 #include <linux/errno.h>
43 #include <linux/idr.h>
44 #include <linux/interrupt.h>
45 #include <linux/init.h>
46 #include <linux/blkdev.h>
47 #include <linux/blkpg.h>
48 #include <linux/blk-pm.h>
49 #include <linux/delay.h>
50 #include <linux/mutex.h>
51 #include <linux/string_helpers.h>
52 #include <linux/async.h>
53 #include <linux/slab.h>
54 #include <linux/sed-opal.h>
55 #include <linux/pm_runtime.h>
56 #include <linux/pr.h>
57 #include <linux/t10-pi.h>
58 #include <linux/uaccess.h>
59 #include <asm/unaligned.h>
61 #include <scsi/scsi.h>
62 #include <scsi/scsi_cmnd.h>
63 #include <scsi/scsi_dbg.h>
64 #include <scsi/scsi_device.h>
65 #include <scsi/scsi_driver.h>
66 #include <scsi/scsi_eh.h>
67 #include <scsi/scsi_host.h>
68 #include <scsi/scsi_ioctl.h>
69 #include <scsi/scsicam.h>
71 #include "sd.h"
72 #include "scsi_priv.h"
73 #include "scsi_logging.h"
75 MODULE_AUTHOR("Eric Youngdale");
76 MODULE_DESCRIPTION("SCSI disk (sd) driver");
77 MODULE_LICENSE("GPL");
79 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
80 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
81 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
82 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
83 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
84 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
85 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
86 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
87 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
88 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
89 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
90 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
91 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
92 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
93 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
94 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
95 MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
96 MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
97 MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
98 MODULE_ALIAS_SCSI_DEVICE(TYPE_ZBC);
100 #if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
101 #define SD_MINORS 16
102 #else
103 #define SD_MINORS 0
104 #endif
106 static void sd_config_discard(struct scsi_disk *, unsigned int);
107 static void sd_config_write_same(struct scsi_disk *);
108 static int sd_revalidate_disk(struct gendisk *);
109 static void sd_unlock_native_capacity(struct gendisk *disk);
110 static int sd_probe(struct device *);
111 static int sd_remove(struct device *);
112 static void sd_shutdown(struct device *);
113 static int sd_suspend_system(struct device *);
114 static int sd_suspend_runtime(struct device *);
115 static int sd_resume(struct device *);
116 static void sd_rescan(struct device *);
117 static int sd_init_command(struct scsi_cmnd *SCpnt);
118 static void sd_uninit_command(struct scsi_cmnd *SCpnt);
119 static int sd_done(struct scsi_cmnd *);
120 static void sd_eh_reset(struct scsi_cmnd *);
121 static int sd_eh_action(struct scsi_cmnd *, int);
122 static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
123 static void scsi_disk_release(struct device *cdev);
124 static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
125 static void sd_print_result(const struct scsi_disk *, const char *, int);
127 static DEFINE_IDA(sd_index_ida);
129 /* This semaphore is used to mediate the 0->1 reference get in the
130 * face of object destruction (i.e. we can't allow a get on an
131 * object after last put) */
132 static DEFINE_MUTEX(sd_ref_mutex);
134 static struct kmem_cache *sd_cdb_cache;
135 static mempool_t *sd_cdb_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;
146 if (sdkp->WCE) {
147 wc = true;
148 if (sdkp->DPOFUA)
149 fua = true;
152 blk_queue_write_cache(sdkp->disk->queue, wc, fua);
155 static ssize_t
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;
162 char buffer[64];
163 char *buffer_data;
164 struct scsi_mode_data data;
165 struct scsi_sense_hdr sshdr;
166 static const char temp[] = "temporary ";
167 int len;
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 */
173 return -EINVAL;
175 if (strncmp(buf, temp, sizeof(temp) - 1) == 0) {
176 buf += sizeof(temp) - 1;
177 sdkp->cache_override = 1;
178 } else {
179 sdkp->cache_override = 0;
182 ct = sysfs_match_string(sd_cache_types, buf);
183 if (ct < 0)
184 return -EINVAL;
186 rcd = ct & 0x01 ? 1 : 0;
187 wce = (ct & 0x02) && !sdkp->write_prot ? 1 : 0;
189 if (sdkp->cache_override) {
190 sdkp->WCE = wce;
191 sdkp->RCD = rcd;
192 sd_set_flush_flag(sdkp);
193 return count;
196 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
197 SD_MAX_RETRIES, &data, NULL))
198 return -EINVAL;
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;
208 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
209 SD_MAX_RETRIES, &data, &sshdr)) {
210 if (scsi_sense_valid(&sshdr))
211 sd_print_sense_hdr(sdkp, &sshdr);
212 return -EINVAL;
214 revalidate_disk(sdkp->disk);
215 return count;
218 static ssize_t
219 manage_start_stop_show(struct device *dev, struct device_attribute *attr,
220 char *buf)
222 struct scsi_disk *sdkp = to_scsi_disk(dev);
223 struct scsi_device *sdp = sdkp->device;
225 return sprintf(buf, "%u\n", sdp->manage_start_stop);
228 static ssize_t
229 manage_start_stop_store(struct device *dev, struct device_attribute *attr,
230 const char *buf, size_t count)
232 struct scsi_disk *sdkp = to_scsi_disk(dev);
233 struct scsi_device *sdp = sdkp->device;
234 bool v;
236 if (!capable(CAP_SYS_ADMIN))
237 return -EACCES;
239 if (kstrtobool(buf, &v))
240 return -EINVAL;
242 sdp->manage_start_stop = v;
244 return count;
246 static DEVICE_ATTR_RW(manage_start_stop);
248 static ssize_t
249 allow_restart_show(struct device *dev, struct device_attribute *attr, char *buf)
251 struct scsi_disk *sdkp = to_scsi_disk(dev);
253 return sprintf(buf, "%u\n", sdkp->device->allow_restart);
256 static ssize_t
257 allow_restart_store(struct device *dev, struct device_attribute *attr,
258 const char *buf, size_t count)
260 bool v;
261 struct scsi_disk *sdkp = to_scsi_disk(dev);
262 struct scsi_device *sdp = sdkp->device;
264 if (!capable(CAP_SYS_ADMIN))
265 return -EACCES;
267 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
268 return -EINVAL;
270 if (kstrtobool(buf, &v))
271 return -EINVAL;
273 sdp->allow_restart = v;
275 return count;
277 static DEVICE_ATTR_RW(allow_restart);
279 static ssize_t
280 cache_type_show(struct device *dev, struct device_attribute *attr, char *buf)
282 struct scsi_disk *sdkp = to_scsi_disk(dev);
283 int ct = sdkp->RCD + 2*sdkp->WCE;
285 return sprintf(buf, "%s\n", sd_cache_types[ct]);
287 static DEVICE_ATTR_RW(cache_type);
289 static ssize_t
290 FUA_show(struct device *dev, struct device_attribute *attr, char *buf)
292 struct scsi_disk *sdkp = to_scsi_disk(dev);
294 return sprintf(buf, "%u\n", sdkp->DPOFUA);
296 static DEVICE_ATTR_RO(FUA);
298 static ssize_t
299 protection_type_show(struct device *dev, struct device_attribute *attr,
300 char *buf)
302 struct scsi_disk *sdkp = to_scsi_disk(dev);
304 return sprintf(buf, "%u\n", sdkp->protection_type);
307 static ssize_t
308 protection_type_store(struct device *dev, struct device_attribute *attr,
309 const char *buf, size_t count)
311 struct scsi_disk *sdkp = to_scsi_disk(dev);
312 unsigned int val;
313 int err;
315 if (!capable(CAP_SYS_ADMIN))
316 return -EACCES;
318 err = kstrtouint(buf, 10, &val);
320 if (err)
321 return err;
323 if (val <= T10_PI_TYPE3_PROTECTION)
324 sdkp->protection_type = val;
326 return count;
328 static DEVICE_ATTR_RW(protection_type);
330 static ssize_t
331 protection_mode_show(struct device *dev, struct device_attribute *attr,
332 char *buf)
334 struct scsi_disk *sdkp = to_scsi_disk(dev);
335 struct scsi_device *sdp = sdkp->device;
336 unsigned int dif, dix;
338 dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
339 dix = scsi_host_dix_capable(sdp->host, sdkp->protection_type);
341 if (!dix && scsi_host_dix_capable(sdp->host, T10_PI_TYPE0_PROTECTION)) {
342 dif = 0;
343 dix = 1;
346 if (!dif && !dix)
347 return sprintf(buf, "none\n");
349 return sprintf(buf, "%s%u\n", dix ? "dix" : "dif", dif);
351 static DEVICE_ATTR_RO(protection_mode);
353 static ssize_t
354 app_tag_own_show(struct device *dev, struct device_attribute *attr, char *buf)
356 struct scsi_disk *sdkp = to_scsi_disk(dev);
358 return sprintf(buf, "%u\n", sdkp->ATO);
360 static DEVICE_ATTR_RO(app_tag_own);
362 static ssize_t
363 thin_provisioning_show(struct device *dev, struct device_attribute *attr,
364 char *buf)
366 struct scsi_disk *sdkp = to_scsi_disk(dev);
368 return sprintf(buf, "%u\n", sdkp->lbpme);
370 static DEVICE_ATTR_RO(thin_provisioning);
372 /* sysfs_match_string() requires dense arrays */
373 static const char *lbp_mode[] = {
374 [SD_LBP_FULL] = "full",
375 [SD_LBP_UNMAP] = "unmap",
376 [SD_LBP_WS16] = "writesame_16",
377 [SD_LBP_WS10] = "writesame_10",
378 [SD_LBP_ZERO] = "writesame_zero",
379 [SD_LBP_DISABLE] = "disabled",
382 static ssize_t
383 provisioning_mode_show(struct device *dev, struct device_attribute *attr,
384 char *buf)
386 struct scsi_disk *sdkp = to_scsi_disk(dev);
388 return sprintf(buf, "%s\n", lbp_mode[sdkp->provisioning_mode]);
391 static ssize_t
392 provisioning_mode_store(struct device *dev, struct device_attribute *attr,
393 const char *buf, size_t count)
395 struct scsi_disk *sdkp = to_scsi_disk(dev);
396 struct scsi_device *sdp = sdkp->device;
397 int mode;
399 if (!capable(CAP_SYS_ADMIN))
400 return -EACCES;
402 if (sd_is_zoned(sdkp)) {
403 sd_config_discard(sdkp, SD_LBP_DISABLE);
404 return count;
407 if (sdp->type != TYPE_DISK)
408 return -EINVAL;
410 mode = sysfs_match_string(lbp_mode, buf);
411 if (mode < 0)
412 return -EINVAL;
414 sd_config_discard(sdkp, mode);
416 return count;
418 static DEVICE_ATTR_RW(provisioning_mode);
420 /* sysfs_match_string() requires dense arrays */
421 static const char *zeroing_mode[] = {
422 [SD_ZERO_WRITE] = "write",
423 [SD_ZERO_WS] = "writesame",
424 [SD_ZERO_WS16_UNMAP] = "writesame_16_unmap",
425 [SD_ZERO_WS10_UNMAP] = "writesame_10_unmap",
428 static ssize_t
429 zeroing_mode_show(struct device *dev, struct device_attribute *attr,
430 char *buf)
432 struct scsi_disk *sdkp = to_scsi_disk(dev);
434 return sprintf(buf, "%s\n", zeroing_mode[sdkp->zeroing_mode]);
437 static ssize_t
438 zeroing_mode_store(struct device *dev, struct device_attribute *attr,
439 const char *buf, size_t count)
441 struct scsi_disk *sdkp = to_scsi_disk(dev);
442 int mode;
444 if (!capable(CAP_SYS_ADMIN))
445 return -EACCES;
447 mode = sysfs_match_string(zeroing_mode, buf);
448 if (mode < 0)
449 return -EINVAL;
451 sdkp->zeroing_mode = mode;
453 return count;
455 static DEVICE_ATTR_RW(zeroing_mode);
457 static ssize_t
458 max_medium_access_timeouts_show(struct device *dev,
459 struct device_attribute *attr, char *buf)
461 struct scsi_disk *sdkp = to_scsi_disk(dev);
463 return sprintf(buf, "%u\n", sdkp->max_medium_access_timeouts);
466 static ssize_t
467 max_medium_access_timeouts_store(struct device *dev,
468 struct device_attribute *attr, const char *buf,
469 size_t count)
471 struct scsi_disk *sdkp = to_scsi_disk(dev);
472 int err;
474 if (!capable(CAP_SYS_ADMIN))
475 return -EACCES;
477 err = kstrtouint(buf, 10, &sdkp->max_medium_access_timeouts);
479 return err ? err : count;
481 static DEVICE_ATTR_RW(max_medium_access_timeouts);
483 static ssize_t
484 max_write_same_blocks_show(struct device *dev, struct device_attribute *attr,
485 char *buf)
487 struct scsi_disk *sdkp = to_scsi_disk(dev);
489 return sprintf(buf, "%u\n", sdkp->max_ws_blocks);
492 static ssize_t
493 max_write_same_blocks_store(struct device *dev, struct device_attribute *attr,
494 const char *buf, size_t count)
496 struct scsi_disk *sdkp = to_scsi_disk(dev);
497 struct scsi_device *sdp = sdkp->device;
498 unsigned long max;
499 int err;
501 if (!capable(CAP_SYS_ADMIN))
502 return -EACCES;
504 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
505 return -EINVAL;
507 err = kstrtoul(buf, 10, &max);
509 if (err)
510 return err;
512 if (max == 0)
513 sdp->no_write_same = 1;
514 else if (max <= SD_MAX_WS16_BLOCKS) {
515 sdp->no_write_same = 0;
516 sdkp->max_ws_blocks = max;
519 sd_config_write_same(sdkp);
521 return count;
523 static DEVICE_ATTR_RW(max_write_same_blocks);
525 static struct attribute *sd_disk_attrs[] = {
526 &dev_attr_cache_type.attr,
527 &dev_attr_FUA.attr,
528 &dev_attr_allow_restart.attr,
529 &dev_attr_manage_start_stop.attr,
530 &dev_attr_protection_type.attr,
531 &dev_attr_protection_mode.attr,
532 &dev_attr_app_tag_own.attr,
533 &dev_attr_thin_provisioning.attr,
534 &dev_attr_provisioning_mode.attr,
535 &dev_attr_zeroing_mode.attr,
536 &dev_attr_max_write_same_blocks.attr,
537 &dev_attr_max_medium_access_timeouts.attr,
538 NULL,
540 ATTRIBUTE_GROUPS(sd_disk);
542 static struct class sd_disk_class = {
543 .name = "scsi_disk",
544 .owner = THIS_MODULE,
545 .dev_release = scsi_disk_release,
546 .dev_groups = sd_disk_groups,
549 static const struct dev_pm_ops sd_pm_ops = {
550 .suspend = sd_suspend_system,
551 .resume = sd_resume,
552 .poweroff = sd_suspend_system,
553 .restore = sd_resume,
554 .runtime_suspend = sd_suspend_runtime,
555 .runtime_resume = sd_resume,
558 static struct scsi_driver sd_template = {
559 .gendrv = {
560 .name = "sd",
561 .owner = THIS_MODULE,
562 .probe = sd_probe,
563 .remove = sd_remove,
564 .shutdown = sd_shutdown,
565 .pm = &sd_pm_ops,
567 .rescan = sd_rescan,
568 .init_command = sd_init_command,
569 .uninit_command = sd_uninit_command,
570 .done = sd_done,
571 .eh_action = sd_eh_action,
572 .eh_reset = sd_eh_reset,
576 * Dummy kobj_map->probe function.
577 * The default ->probe function will call modprobe, which is
578 * pointless as this module is already loaded.
580 static struct kobject *sd_default_probe(dev_t devt, int *partno, void *data)
582 return NULL;
586 * Device no to disk mapping:
588 * major disc2 disc p1
589 * |............|.............|....|....| <- dev_t
590 * 31 20 19 8 7 4 3 0
592 * Inside a major, we have 16k disks, however mapped non-
593 * contiguously. The first 16 disks are for major0, the next
594 * ones with major1, ... Disk 256 is for major0 again, disk 272
595 * for major1, ...
596 * As we stay compatible with our numbering scheme, we can reuse
597 * the well-know SCSI majors 8, 65--71, 136--143.
599 static int sd_major(int major_idx)
601 switch (major_idx) {
602 case 0:
603 return SCSI_DISK0_MAJOR;
604 case 1 ... 7:
605 return SCSI_DISK1_MAJOR + major_idx - 1;
606 case 8 ... 15:
607 return SCSI_DISK8_MAJOR + major_idx - 8;
608 default:
609 BUG();
610 return 0; /* shut up gcc */
614 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
616 struct scsi_disk *sdkp = NULL;
618 mutex_lock(&sd_ref_mutex);
620 if (disk->private_data) {
621 sdkp = scsi_disk(disk);
622 if (scsi_device_get(sdkp->device) == 0)
623 get_device(&sdkp->dev);
624 else
625 sdkp = NULL;
627 mutex_unlock(&sd_ref_mutex);
628 return sdkp;
631 static void scsi_disk_put(struct scsi_disk *sdkp)
633 struct scsi_device *sdev = sdkp->device;
635 mutex_lock(&sd_ref_mutex);
636 put_device(&sdkp->dev);
637 scsi_device_put(sdev);
638 mutex_unlock(&sd_ref_mutex);
641 #ifdef CONFIG_BLK_SED_OPAL
642 static int sd_sec_submit(void *data, u16 spsp, u8 secp, void *buffer,
643 size_t len, bool send)
645 struct scsi_device *sdev = data;
646 u8 cdb[12] = { 0, };
647 int ret;
649 cdb[0] = send ? SECURITY_PROTOCOL_OUT : SECURITY_PROTOCOL_IN;
650 cdb[1] = secp;
651 put_unaligned_be16(spsp, &cdb[2]);
652 put_unaligned_be32(len, &cdb[6]);
654 ret = scsi_execute_req(sdev, cdb,
655 send ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
656 buffer, len, NULL, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
657 return ret <= 0 ? ret : -EIO;
659 #endif /* CONFIG_BLK_SED_OPAL */
661 static unsigned char sd_setup_protect_cmnd(struct scsi_cmnd *scmd,
662 unsigned int dix, unsigned int dif)
664 struct bio *bio = scmd->request->bio;
665 unsigned int prot_op = sd_prot_op(rq_data_dir(scmd->request), dix, dif);
666 unsigned int protect = 0;
668 if (dix) { /* DIX Type 0, 1, 2, 3 */
669 if (bio_integrity_flagged(bio, BIP_IP_CHECKSUM))
670 scmd->prot_flags |= SCSI_PROT_IP_CHECKSUM;
672 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
673 scmd->prot_flags |= SCSI_PROT_GUARD_CHECK;
676 if (dif != T10_PI_TYPE3_PROTECTION) { /* DIX/DIF Type 0, 1, 2 */
677 scmd->prot_flags |= SCSI_PROT_REF_INCREMENT;
679 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
680 scmd->prot_flags |= SCSI_PROT_REF_CHECK;
683 if (dif) { /* DIX/DIF Type 1, 2, 3 */
684 scmd->prot_flags |= SCSI_PROT_TRANSFER_PI;
686 if (bio_integrity_flagged(bio, BIP_DISK_NOCHECK))
687 protect = 3 << 5; /* Disable target PI checking */
688 else
689 protect = 1 << 5; /* Enable target PI checking */
692 scsi_set_prot_op(scmd, prot_op);
693 scsi_set_prot_type(scmd, dif);
694 scmd->prot_flags &= sd_prot_flag_mask(prot_op);
696 return protect;
699 static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
701 struct request_queue *q = sdkp->disk->queue;
702 unsigned int logical_block_size = sdkp->device->sector_size;
703 unsigned int max_blocks = 0;
705 q->limits.discard_alignment =
706 sdkp->unmap_alignment * logical_block_size;
707 q->limits.discard_granularity =
708 max(sdkp->physical_block_size,
709 sdkp->unmap_granularity * logical_block_size);
710 sdkp->provisioning_mode = mode;
712 switch (mode) {
714 case SD_LBP_FULL:
715 case SD_LBP_DISABLE:
716 blk_queue_max_discard_sectors(q, 0);
717 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
718 return;
720 case SD_LBP_UNMAP:
721 max_blocks = min_not_zero(sdkp->max_unmap_blocks,
722 (u32)SD_MAX_WS16_BLOCKS);
723 break;
725 case SD_LBP_WS16:
726 if (sdkp->device->unmap_limit_for_ws)
727 max_blocks = sdkp->max_unmap_blocks;
728 else
729 max_blocks = sdkp->max_ws_blocks;
731 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS16_BLOCKS);
732 break;
734 case SD_LBP_WS10:
735 if (sdkp->device->unmap_limit_for_ws)
736 max_blocks = sdkp->max_unmap_blocks;
737 else
738 max_blocks = sdkp->max_ws_blocks;
740 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS10_BLOCKS);
741 break;
743 case SD_LBP_ZERO:
744 max_blocks = min_not_zero(sdkp->max_ws_blocks,
745 (u32)SD_MAX_WS10_BLOCKS);
746 break;
749 blk_queue_max_discard_sectors(q, max_blocks * (logical_block_size >> 9));
750 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
753 static int sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
755 struct scsi_device *sdp = cmd->device;
756 struct request *rq = cmd->request;
757 u64 sector = blk_rq_pos(rq) >> (ilog2(sdp->sector_size) - 9);
758 u32 nr_sectors = blk_rq_sectors(rq) >> (ilog2(sdp->sector_size) - 9);
759 unsigned int data_len = 24;
760 char *buf;
762 rq->special_vec.bv_page = alloc_page(GFP_ATOMIC | __GFP_ZERO);
763 if (!rq->special_vec.bv_page)
764 return BLKPREP_DEFER;
765 rq->special_vec.bv_offset = 0;
766 rq->special_vec.bv_len = data_len;
767 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
769 cmd->cmd_len = 10;
770 cmd->cmnd[0] = UNMAP;
771 cmd->cmnd[8] = 24;
773 buf = page_address(rq->special_vec.bv_page);
774 put_unaligned_be16(6 + 16, &buf[0]);
775 put_unaligned_be16(16, &buf[2]);
776 put_unaligned_be64(sector, &buf[8]);
777 put_unaligned_be32(nr_sectors, &buf[16]);
779 cmd->allowed = SD_MAX_RETRIES;
780 cmd->transfersize = data_len;
781 rq->timeout = SD_TIMEOUT;
782 scsi_req(rq)->resid_len = data_len;
784 return scsi_init_io(cmd);
787 static int sd_setup_write_same16_cmnd(struct scsi_cmnd *cmd, bool unmap)
789 struct scsi_device *sdp = cmd->device;
790 struct request *rq = cmd->request;
791 u64 sector = blk_rq_pos(rq) >> (ilog2(sdp->sector_size) - 9);
792 u32 nr_sectors = blk_rq_sectors(rq) >> (ilog2(sdp->sector_size) - 9);
793 u32 data_len = sdp->sector_size;
795 rq->special_vec.bv_page = alloc_page(GFP_ATOMIC | __GFP_ZERO);
796 if (!rq->special_vec.bv_page)
797 return BLKPREP_DEFER;
798 rq->special_vec.bv_offset = 0;
799 rq->special_vec.bv_len = data_len;
800 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
802 cmd->cmd_len = 16;
803 cmd->cmnd[0] = WRITE_SAME_16;
804 if (unmap)
805 cmd->cmnd[1] = 0x8; /* UNMAP */
806 put_unaligned_be64(sector, &cmd->cmnd[2]);
807 put_unaligned_be32(nr_sectors, &cmd->cmnd[10]);
809 cmd->allowed = SD_MAX_RETRIES;
810 cmd->transfersize = data_len;
811 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
812 scsi_req(rq)->resid_len = data_len;
814 return scsi_init_io(cmd);
817 static int sd_setup_write_same10_cmnd(struct scsi_cmnd *cmd, bool unmap)
819 struct scsi_device *sdp = cmd->device;
820 struct request *rq = cmd->request;
821 u64 sector = blk_rq_pos(rq) >> (ilog2(sdp->sector_size) - 9);
822 u32 nr_sectors = blk_rq_sectors(rq) >> (ilog2(sdp->sector_size) - 9);
823 u32 data_len = sdp->sector_size;
825 rq->special_vec.bv_page = alloc_page(GFP_ATOMIC | __GFP_ZERO);
826 if (!rq->special_vec.bv_page)
827 return BLKPREP_DEFER;
828 rq->special_vec.bv_offset = 0;
829 rq->special_vec.bv_len = data_len;
830 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
832 cmd->cmd_len = 10;
833 cmd->cmnd[0] = WRITE_SAME;
834 if (unmap)
835 cmd->cmnd[1] = 0x8; /* UNMAP */
836 put_unaligned_be32(sector, &cmd->cmnd[2]);
837 put_unaligned_be16(nr_sectors, &cmd->cmnd[7]);
839 cmd->allowed = SD_MAX_RETRIES;
840 cmd->transfersize = data_len;
841 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
842 scsi_req(rq)->resid_len = data_len;
844 return scsi_init_io(cmd);
847 static int sd_setup_write_zeroes_cmnd(struct scsi_cmnd *cmd)
849 struct request *rq = cmd->request;
850 struct scsi_device *sdp = cmd->device;
851 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
852 u64 sector = blk_rq_pos(rq) >> (ilog2(sdp->sector_size) - 9);
853 u32 nr_sectors = blk_rq_sectors(rq) >> (ilog2(sdp->sector_size) - 9);
855 if (!(rq->cmd_flags & REQ_NOUNMAP)) {
856 switch (sdkp->zeroing_mode) {
857 case SD_ZERO_WS16_UNMAP:
858 return sd_setup_write_same16_cmnd(cmd, true);
859 case SD_ZERO_WS10_UNMAP:
860 return sd_setup_write_same10_cmnd(cmd, true);
864 if (sdp->no_write_same)
865 return BLKPREP_INVALID;
867 if (sdkp->ws16 || sector > 0xffffffff || nr_sectors > 0xffff)
868 return sd_setup_write_same16_cmnd(cmd, false);
870 return sd_setup_write_same10_cmnd(cmd, false);
873 static void sd_config_write_same(struct scsi_disk *sdkp)
875 struct request_queue *q = sdkp->disk->queue;
876 unsigned int logical_block_size = sdkp->device->sector_size;
878 if (sdkp->device->no_write_same) {
879 sdkp->max_ws_blocks = 0;
880 goto out;
883 /* Some devices can not handle block counts above 0xffff despite
884 * supporting WRITE SAME(16). Consequently we default to 64k
885 * blocks per I/O unless the device explicitly advertises a
886 * bigger limit.
888 if (sdkp->max_ws_blocks > SD_MAX_WS10_BLOCKS)
889 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
890 (u32)SD_MAX_WS16_BLOCKS);
891 else if (sdkp->ws16 || sdkp->ws10 || sdkp->device->no_report_opcodes)
892 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
893 (u32)SD_MAX_WS10_BLOCKS);
894 else {
895 sdkp->device->no_write_same = 1;
896 sdkp->max_ws_blocks = 0;
899 if (sdkp->lbprz && sdkp->lbpws)
900 sdkp->zeroing_mode = SD_ZERO_WS16_UNMAP;
901 else if (sdkp->lbprz && sdkp->lbpws10)
902 sdkp->zeroing_mode = SD_ZERO_WS10_UNMAP;
903 else if (sdkp->max_ws_blocks)
904 sdkp->zeroing_mode = SD_ZERO_WS;
905 else
906 sdkp->zeroing_mode = SD_ZERO_WRITE;
908 if (sdkp->max_ws_blocks &&
909 sdkp->physical_block_size > logical_block_size) {
911 * Reporting a maximum number of blocks that is not aligned
912 * on the device physical size would cause a large write same
913 * request to be split into physically unaligned chunks by
914 * __blkdev_issue_write_zeroes() and __blkdev_issue_write_same()
915 * even if the caller of these functions took care to align the
916 * large request. So make sure the maximum reported is aligned
917 * to the device physical block size. This is only an optional
918 * optimization for regular disks, but this is mandatory to
919 * avoid failure of large write same requests directed at
920 * sequential write required zones of host-managed ZBC disks.
922 sdkp->max_ws_blocks =
923 round_down(sdkp->max_ws_blocks,
924 bytes_to_logical(sdkp->device,
925 sdkp->physical_block_size));
928 out:
929 blk_queue_max_write_same_sectors(q, sdkp->max_ws_blocks *
930 (logical_block_size >> 9));
931 blk_queue_max_write_zeroes_sectors(q, sdkp->max_ws_blocks *
932 (logical_block_size >> 9));
936 * sd_setup_write_same_cmnd - write the same data to multiple blocks
937 * @cmd: command to prepare
939 * Will set up either WRITE SAME(10) or WRITE SAME(16) depending on
940 * the preference indicated by the target device.
942 static int sd_setup_write_same_cmnd(struct scsi_cmnd *cmd)
944 struct request *rq = cmd->request;
945 struct scsi_device *sdp = cmd->device;
946 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
947 struct bio *bio = rq->bio;
948 sector_t sector = blk_rq_pos(rq);
949 unsigned int nr_sectors = blk_rq_sectors(rq);
950 unsigned int nr_bytes = blk_rq_bytes(rq);
951 int ret;
953 if (sdkp->device->no_write_same)
954 return BLKPREP_INVALID;
956 BUG_ON(bio_offset(bio) || bio_iovec(bio).bv_len != sdp->sector_size);
958 sector >>= ilog2(sdp->sector_size) - 9;
959 nr_sectors >>= ilog2(sdp->sector_size) - 9;
961 rq->timeout = SD_WRITE_SAME_TIMEOUT;
963 if (sdkp->ws16 || sector > 0xffffffff || nr_sectors > 0xffff) {
964 cmd->cmd_len = 16;
965 cmd->cmnd[0] = WRITE_SAME_16;
966 put_unaligned_be64(sector, &cmd->cmnd[2]);
967 put_unaligned_be32(nr_sectors, &cmd->cmnd[10]);
968 } else {
969 cmd->cmd_len = 10;
970 cmd->cmnd[0] = WRITE_SAME;
971 put_unaligned_be32(sector, &cmd->cmnd[2]);
972 put_unaligned_be16(nr_sectors, &cmd->cmnd[7]);
975 cmd->transfersize = sdp->sector_size;
976 cmd->allowed = SD_MAX_RETRIES;
979 * For WRITE SAME the data transferred via the DATA OUT buffer is
980 * different from the amount of data actually written to the target.
982 * We set up __data_len to the amount of data transferred via the
983 * DATA OUT buffer so that blk_rq_map_sg sets up the proper S/G list
984 * to transfer a single sector of data first, but then reset it to
985 * the amount of data to be written right after so that the I/O path
986 * knows how much to actually write.
988 rq->__data_len = sdp->sector_size;
989 ret = scsi_init_io(cmd);
990 rq->__data_len = nr_bytes;
992 return ret;
995 static int sd_setup_flush_cmnd(struct scsi_cmnd *cmd)
997 struct request *rq = cmd->request;
999 /* flush requests don't perform I/O, zero the S/G table */
1000 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1002 cmd->cmnd[0] = SYNCHRONIZE_CACHE;
1003 cmd->cmd_len = 10;
1004 cmd->transfersize = 0;
1005 cmd->allowed = SD_MAX_RETRIES;
1007 rq->timeout = rq->q->rq_timeout * SD_FLUSH_TIMEOUT_MULTIPLIER;
1008 return BLKPREP_OK;
1011 static int sd_setup_read_write_cmnd(struct scsi_cmnd *SCpnt)
1013 struct request *rq = SCpnt->request;
1014 struct scsi_device *sdp = SCpnt->device;
1015 struct gendisk *disk = rq->rq_disk;
1016 struct scsi_disk *sdkp = scsi_disk(disk);
1017 sector_t block = blk_rq_pos(rq);
1018 sector_t threshold;
1019 unsigned int this_count = blk_rq_sectors(rq);
1020 unsigned int dif, dix;
1021 int ret;
1022 unsigned char protect;
1024 ret = scsi_init_io(SCpnt);
1025 if (ret != BLKPREP_OK)
1026 return ret;
1027 WARN_ON_ONCE(SCpnt != rq->special);
1029 /* from here on until we're complete, any goto out
1030 * is used for a killable error condition */
1031 ret = BLKPREP_KILL;
1033 SCSI_LOG_HLQUEUE(1,
1034 scmd_printk(KERN_INFO, SCpnt,
1035 "%s: block=%llu, count=%d\n",
1036 __func__, (unsigned long long)block, this_count));
1038 if (!sdp || !scsi_device_online(sdp) ||
1039 block + blk_rq_sectors(rq) > get_capacity(disk)) {
1040 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
1041 "Finishing %u sectors\n",
1042 blk_rq_sectors(rq)));
1043 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
1044 "Retry with 0x%p\n", SCpnt));
1045 goto out;
1048 if (sdp->changed) {
1050 * quietly refuse to do anything to a changed disc until
1051 * the changed bit has been reset
1053 /* printk("SCSI disk has been changed or is not present. Prohibiting further I/O.\n"); */
1054 goto out;
1058 * Some SD card readers can't handle multi-sector accesses which touch
1059 * the last one or two hardware sectors. Split accesses as needed.
1061 threshold = get_capacity(disk) - SD_LAST_BUGGY_SECTORS *
1062 (sdp->sector_size / 512);
1064 if (unlikely(sdp->last_sector_bug && block + this_count > threshold)) {
1065 if (block < threshold) {
1066 /* Access up to the threshold but not beyond */
1067 this_count = threshold - block;
1068 } else {
1069 /* Access only a single hardware sector */
1070 this_count = sdp->sector_size / 512;
1074 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
1075 (unsigned long long)block));
1078 * If we have a 1K hardware sectorsize, prevent access to single
1079 * 512 byte sectors. In theory we could handle this - in fact
1080 * the scsi cdrom driver must be able to handle this because
1081 * we typically use 1K blocksizes, and cdroms typically have
1082 * 2K hardware sectorsizes. Of course, things are simpler
1083 * with the cdrom, since it is read-only. For performance
1084 * reasons, the filesystems should be able to handle this
1085 * and not force the scsi disk driver to use bounce buffers
1086 * for this.
1088 if (sdp->sector_size == 1024) {
1089 if ((block & 1) || (blk_rq_sectors(rq) & 1)) {
1090 scmd_printk(KERN_ERR, SCpnt,
1091 "Bad block number requested\n");
1092 goto out;
1093 } else {
1094 block = block >> 1;
1095 this_count = this_count >> 1;
1098 if (sdp->sector_size == 2048) {
1099 if ((block & 3) || (blk_rq_sectors(rq) & 3)) {
1100 scmd_printk(KERN_ERR, SCpnt,
1101 "Bad block number requested\n");
1102 goto out;
1103 } else {
1104 block = block >> 2;
1105 this_count = this_count >> 2;
1108 if (sdp->sector_size == 4096) {
1109 if ((block & 7) || (blk_rq_sectors(rq) & 7)) {
1110 scmd_printk(KERN_ERR, SCpnt,
1111 "Bad block number requested\n");
1112 goto out;
1113 } else {
1114 block = block >> 3;
1115 this_count = this_count >> 3;
1118 if (rq_data_dir(rq) == WRITE) {
1119 SCpnt->cmnd[0] = WRITE_6;
1121 if (blk_integrity_rq(rq))
1122 t10_pi_prepare(SCpnt->request, sdkp->protection_type);
1124 } else if (rq_data_dir(rq) == READ) {
1125 SCpnt->cmnd[0] = READ_6;
1126 } else {
1127 scmd_printk(KERN_ERR, SCpnt, "Unknown command %d\n", req_op(rq));
1128 goto out;
1131 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
1132 "%s %d/%u 512 byte blocks.\n",
1133 (rq_data_dir(rq) == WRITE) ?
1134 "writing" : "reading", this_count,
1135 blk_rq_sectors(rq)));
1137 dix = scsi_prot_sg_count(SCpnt);
1138 dif = scsi_host_dif_capable(SCpnt->device->host, sdkp->protection_type);
1140 if (dif || dix)
1141 protect = sd_setup_protect_cmnd(SCpnt, dix, dif);
1142 else
1143 protect = 0;
1145 if (protect && sdkp->protection_type == T10_PI_TYPE2_PROTECTION) {
1146 SCpnt->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
1148 if (unlikely(SCpnt->cmnd == NULL)) {
1149 ret = BLKPREP_DEFER;
1150 goto out;
1153 SCpnt->cmd_len = SD_EXT_CDB_SIZE;
1154 memset(SCpnt->cmnd, 0, SCpnt->cmd_len);
1155 SCpnt->cmnd[0] = VARIABLE_LENGTH_CMD;
1156 SCpnt->cmnd[7] = 0x18;
1157 SCpnt->cmnd[9] = (rq_data_dir(rq) == READ) ? READ_32 : WRITE_32;
1158 SCpnt->cmnd[10] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
1160 /* LBA */
1161 SCpnt->cmnd[12] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
1162 SCpnt->cmnd[13] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
1163 SCpnt->cmnd[14] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
1164 SCpnt->cmnd[15] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
1165 SCpnt->cmnd[16] = (unsigned char) (block >> 24) & 0xff;
1166 SCpnt->cmnd[17] = (unsigned char) (block >> 16) & 0xff;
1167 SCpnt->cmnd[18] = (unsigned char) (block >> 8) & 0xff;
1168 SCpnt->cmnd[19] = (unsigned char) block & 0xff;
1170 /* Expected Indirect LBA */
1171 SCpnt->cmnd[20] = (unsigned char) (block >> 24) & 0xff;
1172 SCpnt->cmnd[21] = (unsigned char) (block >> 16) & 0xff;
1173 SCpnt->cmnd[22] = (unsigned char) (block >> 8) & 0xff;
1174 SCpnt->cmnd[23] = (unsigned char) block & 0xff;
1176 /* Transfer length */
1177 SCpnt->cmnd[28] = (unsigned char) (this_count >> 24) & 0xff;
1178 SCpnt->cmnd[29] = (unsigned char) (this_count >> 16) & 0xff;
1179 SCpnt->cmnd[30] = (unsigned char) (this_count >> 8) & 0xff;
1180 SCpnt->cmnd[31] = (unsigned char) this_count & 0xff;
1181 } else if (sdp->use_16_for_rw || (this_count > 0xffff)) {
1182 SCpnt->cmnd[0] += READ_16 - READ_6;
1183 SCpnt->cmnd[1] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
1184 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
1185 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
1186 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
1187 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
1188 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
1189 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
1190 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
1191 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
1192 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
1193 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
1194 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
1195 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
1196 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
1197 } else if ((this_count > 0xff) || (block > 0x1fffff) ||
1198 scsi_device_protection(SCpnt->device) ||
1199 SCpnt->device->use_10_for_rw) {
1200 SCpnt->cmnd[0] += READ_10 - READ_6;
1201 SCpnt->cmnd[1] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
1202 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
1203 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
1204 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
1205 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
1206 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
1207 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
1208 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
1209 } else {
1210 if (unlikely(rq->cmd_flags & REQ_FUA)) {
1212 * This happens only if this drive failed
1213 * 10byte rw command with ILLEGAL_REQUEST
1214 * during operation and thus turned off
1215 * use_10_for_rw.
1217 scmd_printk(KERN_ERR, SCpnt,
1218 "FUA write on READ/WRITE(6) drive\n");
1219 goto out;
1222 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
1223 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
1224 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
1225 SCpnt->cmnd[4] = (unsigned char) this_count;
1226 SCpnt->cmnd[5] = 0;
1228 SCpnt->sdb.length = this_count * sdp->sector_size;
1231 * We shouldn't disconnect in the middle of a sector, so with a dumb
1232 * host adapter, it's safe to assume that we can at least transfer
1233 * this many bytes between each connect / disconnect.
1235 SCpnt->transfersize = sdp->sector_size;
1236 SCpnt->underflow = this_count << 9;
1237 SCpnt->allowed = SD_MAX_RETRIES;
1240 * This indicates that the command is ready from our end to be
1241 * queued.
1243 ret = BLKPREP_OK;
1244 out:
1245 return ret;
1248 static int sd_init_command(struct scsi_cmnd *cmd)
1250 struct request *rq = cmd->request;
1252 switch (req_op(rq)) {
1253 case REQ_OP_DISCARD:
1254 switch (scsi_disk(rq->rq_disk)->provisioning_mode) {
1255 case SD_LBP_UNMAP:
1256 return sd_setup_unmap_cmnd(cmd);
1257 case SD_LBP_WS16:
1258 return sd_setup_write_same16_cmnd(cmd, true);
1259 case SD_LBP_WS10:
1260 return sd_setup_write_same10_cmnd(cmd, true);
1261 case SD_LBP_ZERO:
1262 return sd_setup_write_same10_cmnd(cmd, false);
1263 default:
1264 return BLKPREP_INVALID;
1266 case REQ_OP_WRITE_ZEROES:
1267 return sd_setup_write_zeroes_cmnd(cmd);
1268 case REQ_OP_WRITE_SAME:
1269 return sd_setup_write_same_cmnd(cmd);
1270 case REQ_OP_FLUSH:
1271 return sd_setup_flush_cmnd(cmd);
1272 case REQ_OP_READ:
1273 case REQ_OP_WRITE:
1274 return sd_setup_read_write_cmnd(cmd);
1275 case REQ_OP_ZONE_RESET:
1276 return sd_zbc_setup_reset_cmnd(cmd);
1277 default:
1278 WARN_ON_ONCE(1);
1279 return BLKPREP_KILL;
1283 static void sd_uninit_command(struct scsi_cmnd *SCpnt)
1285 struct request *rq = SCpnt->request;
1286 u8 *cmnd;
1288 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1289 __free_page(rq->special_vec.bv_page);
1291 if (SCpnt->cmnd != scsi_req(rq)->cmd) {
1292 cmnd = SCpnt->cmnd;
1293 SCpnt->cmnd = NULL;
1294 SCpnt->cmd_len = 0;
1295 mempool_free(cmnd, sd_cdb_pool);
1300 * sd_open - open a scsi disk device
1301 * @bdev: Block device of the scsi disk to open
1302 * @mode: FMODE_* mask
1304 * Returns 0 if successful. Returns a negated errno value in case
1305 * of error.
1307 * Note: This can be called from a user context (e.g. fsck(1) )
1308 * or from within the kernel (e.g. as a result of a mount(1) ).
1309 * In the latter case @inode and @filp carry an abridged amount
1310 * of information as noted above.
1312 * Locking: called with bdev->bd_mutex held.
1314 static int sd_open(struct block_device *bdev, fmode_t mode)
1316 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
1317 struct scsi_device *sdev;
1318 int retval;
1320 if (!sdkp)
1321 return -ENXIO;
1323 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
1325 sdev = sdkp->device;
1328 * If the device is in error recovery, wait until it is done.
1329 * If the device is offline, then disallow any access to it.
1331 retval = -ENXIO;
1332 if (!scsi_block_when_processing_errors(sdev))
1333 goto error_out;
1335 if (sdev->removable || sdkp->write_prot)
1336 check_disk_change(bdev);
1339 * If the drive is empty, just let the open fail.
1341 retval = -ENOMEDIUM;
1342 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
1343 goto error_out;
1346 * If the device has the write protect tab set, have the open fail
1347 * if the user expects to be able to write to the thing.
1349 retval = -EROFS;
1350 if (sdkp->write_prot && (mode & FMODE_WRITE))
1351 goto error_out;
1354 * It is possible that the disk changing stuff resulted in
1355 * the device being taken offline. If this is the case,
1356 * report this to the user, and don't pretend that the
1357 * open actually succeeded.
1359 retval = -ENXIO;
1360 if (!scsi_device_online(sdev))
1361 goto error_out;
1363 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
1364 if (scsi_block_when_processing_errors(sdev))
1365 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1368 return 0;
1370 error_out:
1371 scsi_disk_put(sdkp);
1372 return retval;
1376 * sd_release - invoked when the (last) close(2) is called on this
1377 * scsi disk.
1378 * @disk: disk to release
1379 * @mode: FMODE_* mask
1381 * Returns 0.
1383 * Note: may block (uninterruptible) if error recovery is underway
1384 * on this disk.
1386 * Locking: called with bdev->bd_mutex held.
1388 static void sd_release(struct gendisk *disk, fmode_t mode)
1390 struct scsi_disk *sdkp = scsi_disk(disk);
1391 struct scsi_device *sdev = sdkp->device;
1393 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1395 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
1396 if (scsi_block_when_processing_errors(sdev))
1397 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1401 * XXX and what if there are packets in flight and this close()
1402 * XXX is followed by a "rmmod sd_mod"?
1405 scsi_disk_put(sdkp);
1408 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1410 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1411 struct scsi_device *sdp = sdkp->device;
1412 struct Scsi_Host *host = sdp->host;
1413 sector_t capacity = logical_to_sectors(sdp, sdkp->capacity);
1414 int diskinfo[4];
1416 /* default to most commonly used values */
1417 diskinfo[0] = 0x40; /* 1 << 6 */
1418 diskinfo[1] = 0x20; /* 1 << 5 */
1419 diskinfo[2] = capacity >> 11;
1421 /* override with calculated, extended default, or driver values */
1422 if (host->hostt->bios_param)
1423 host->hostt->bios_param(sdp, bdev, capacity, diskinfo);
1424 else
1425 scsicam_bios_param(bdev, capacity, diskinfo);
1427 geo->heads = diskinfo[0];
1428 geo->sectors = diskinfo[1];
1429 geo->cylinders = diskinfo[2];
1430 return 0;
1434 * sd_ioctl - process an ioctl
1435 * @bdev: target block device
1436 * @mode: FMODE_* mask
1437 * @cmd: ioctl command number
1438 * @arg: this is third argument given to ioctl(2) system call.
1439 * Often contains a pointer.
1441 * Returns 0 if successful (some ioctls return positive numbers on
1442 * success as well). Returns a negated errno value in case of error.
1444 * Note: most ioctls are forward onto the block subsystem or further
1445 * down in the scsi subsystem.
1447 static int sd_ioctl(struct block_device *bdev, fmode_t mode,
1448 unsigned int cmd, unsigned long arg)
1450 struct gendisk *disk = bdev->bd_disk;
1451 struct scsi_disk *sdkp = scsi_disk(disk);
1452 struct scsi_device *sdp = sdkp->device;
1453 void __user *p = (void __user *)arg;
1454 int error;
1456 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1457 "cmd=0x%x\n", disk->disk_name, cmd));
1459 error = scsi_verify_blk_ioctl(bdev, cmd);
1460 if (error < 0)
1461 return error;
1464 * If we are in the middle of error recovery, don't let anyone
1465 * else try and use this device. Also, if error recovery fails, it
1466 * may try and take the device offline, in which case all further
1467 * access to the device is prohibited.
1469 error = scsi_ioctl_block_when_processing_errors(sdp, cmd,
1470 (mode & FMODE_NDELAY) != 0);
1471 if (error)
1472 goto out;
1474 if (is_sed_ioctl(cmd))
1475 return sed_ioctl(sdkp->opal_dev, cmd, p);
1478 * Send SCSI addressing ioctls directly to mid level, send other
1479 * ioctls to block level and then onto mid level if they can't be
1480 * resolved.
1482 switch (cmd) {
1483 case SCSI_IOCTL_GET_IDLUN:
1484 case SCSI_IOCTL_GET_BUS_NUMBER:
1485 error = scsi_ioctl(sdp, cmd, p);
1486 break;
1487 default:
1488 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
1489 if (error != -ENOTTY)
1490 break;
1491 error = scsi_ioctl(sdp, cmd, p);
1492 break;
1494 out:
1495 return error;
1498 static void set_media_not_present(struct scsi_disk *sdkp)
1500 if (sdkp->media_present)
1501 sdkp->device->changed = 1;
1503 if (sdkp->device->removable) {
1504 sdkp->media_present = 0;
1505 sdkp->capacity = 0;
1509 static int media_not_present(struct scsi_disk *sdkp,
1510 struct scsi_sense_hdr *sshdr)
1512 if (!scsi_sense_valid(sshdr))
1513 return 0;
1515 /* not invoked for commands that could return deferred errors */
1516 switch (sshdr->sense_key) {
1517 case UNIT_ATTENTION:
1518 case NOT_READY:
1519 /* medium not present */
1520 if (sshdr->asc == 0x3A) {
1521 set_media_not_present(sdkp);
1522 return 1;
1525 return 0;
1529 * sd_check_events - check media events
1530 * @disk: kernel device descriptor
1531 * @clearing: disk events currently being cleared
1533 * Returns mask of DISK_EVENT_*.
1535 * Note: this function is invoked from the block subsystem.
1537 static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
1539 struct scsi_disk *sdkp = scsi_disk_get(disk);
1540 struct scsi_device *sdp;
1541 int retval;
1543 if (!sdkp)
1544 return 0;
1546 sdp = sdkp->device;
1547 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
1550 * If the device is offline, don't send any commands - just pretend as
1551 * if the command failed. If the device ever comes back online, we
1552 * can deal with it then. It is only because of unrecoverable errors
1553 * that we would ever take a device offline in the first place.
1555 if (!scsi_device_online(sdp)) {
1556 set_media_not_present(sdkp);
1557 goto out;
1561 * Using TEST_UNIT_READY enables differentiation between drive with
1562 * no cartridge loaded - NOT READY, drive with changed cartridge -
1563 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1565 * Drives that auto spin down. eg iomega jaz 1G, will be started
1566 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1567 * sd_revalidate() is called.
1569 if (scsi_block_when_processing_errors(sdp)) {
1570 struct scsi_sense_hdr sshdr = { 0, };
1572 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
1573 &sshdr);
1575 /* failed to execute TUR, assume media not present */
1576 if (host_byte(retval)) {
1577 set_media_not_present(sdkp);
1578 goto out;
1581 if (media_not_present(sdkp, &sshdr))
1582 goto out;
1586 * For removable scsi disk we have to recognise the presence
1587 * of a disk in the drive.
1589 if (!sdkp->media_present)
1590 sdp->changed = 1;
1591 sdkp->media_present = 1;
1592 out:
1594 * sdp->changed is set under the following conditions:
1596 * Medium present state has changed in either direction.
1597 * Device has indicated UNIT_ATTENTION.
1599 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1600 sdp->changed = 0;
1601 scsi_disk_put(sdkp);
1602 return retval;
1605 static int sd_sync_cache(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
1607 int retries, res;
1608 struct scsi_device *sdp = sdkp->device;
1609 const int timeout = sdp->request_queue->rq_timeout
1610 * SD_FLUSH_TIMEOUT_MULTIPLIER;
1611 struct scsi_sense_hdr my_sshdr;
1613 if (!scsi_device_online(sdp))
1614 return -ENODEV;
1616 /* caller might not be interested in sense, but we need it */
1617 if (!sshdr)
1618 sshdr = &my_sshdr;
1620 for (retries = 3; retries > 0; --retries) {
1621 unsigned char cmd[10] = { 0 };
1623 cmd[0] = SYNCHRONIZE_CACHE;
1625 * Leave the rest of the command zero to indicate
1626 * flush everything.
1628 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, sshdr,
1629 timeout, SD_MAX_RETRIES, 0, RQF_PM, NULL);
1630 if (res == 0)
1631 break;
1634 if (res) {
1635 sd_print_result(sdkp, "Synchronize Cache(10) failed", res);
1637 if (driver_byte(res) == DRIVER_SENSE)
1638 sd_print_sense_hdr(sdkp, sshdr);
1640 /* we need to evaluate the error return */
1641 if (scsi_sense_valid(sshdr) &&
1642 (sshdr->asc == 0x3a || /* medium not present */
1643 sshdr->asc == 0x20)) /* invalid command */
1644 /* this is no error here */
1645 return 0;
1647 switch (host_byte(res)) {
1648 /* ignore errors due to racing a disconnection */
1649 case DID_BAD_TARGET:
1650 case DID_NO_CONNECT:
1651 return 0;
1652 /* signal the upper layer it might try again */
1653 case DID_BUS_BUSY:
1654 case DID_IMM_RETRY:
1655 case DID_REQUEUE:
1656 case DID_SOFT_ERROR:
1657 return -EBUSY;
1658 default:
1659 return -EIO;
1662 return 0;
1665 static void sd_rescan(struct device *dev)
1667 struct scsi_disk *sdkp = dev_get_drvdata(dev);
1669 revalidate_disk(sdkp->disk);
1673 #ifdef CONFIG_COMPAT
1675 * This gets directly called from VFS. When the ioctl
1676 * is not recognized we go back to the other translation paths.
1678 static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1679 unsigned int cmd, unsigned long arg)
1681 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1682 int error;
1684 error = scsi_ioctl_block_when_processing_errors(sdev, cmd,
1685 (mode & FMODE_NDELAY) != 0);
1686 if (error)
1687 return error;
1690 * Let the static ioctl translation table take care of it.
1692 if (!sdev->host->hostt->compat_ioctl)
1693 return -ENOIOCTLCMD;
1694 return sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
1696 #endif
1698 static char sd_pr_type(enum pr_type type)
1700 switch (type) {
1701 case PR_WRITE_EXCLUSIVE:
1702 return 0x01;
1703 case PR_EXCLUSIVE_ACCESS:
1704 return 0x03;
1705 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1706 return 0x05;
1707 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1708 return 0x06;
1709 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1710 return 0x07;
1711 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1712 return 0x08;
1713 default:
1714 return 0;
1718 static int sd_pr_command(struct block_device *bdev, u8 sa,
1719 u64 key, u64 sa_key, u8 type, u8 flags)
1721 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1722 struct scsi_sense_hdr sshdr;
1723 int result;
1724 u8 cmd[16] = { 0, };
1725 u8 data[24] = { 0, };
1727 cmd[0] = PERSISTENT_RESERVE_OUT;
1728 cmd[1] = sa;
1729 cmd[2] = type;
1730 put_unaligned_be32(sizeof(data), &cmd[5]);
1732 put_unaligned_be64(key, &data[0]);
1733 put_unaligned_be64(sa_key, &data[8]);
1734 data[20] = flags;
1736 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, &data, sizeof(data),
1737 &sshdr, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1739 if (driver_byte(result) == DRIVER_SENSE &&
1740 scsi_sense_valid(&sshdr)) {
1741 sdev_printk(KERN_INFO, sdev, "PR command failed: %d\n", result);
1742 scsi_print_sense_hdr(sdev, NULL, &sshdr);
1745 return result;
1748 static int sd_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
1749 u32 flags)
1751 if (flags & ~PR_FL_IGNORE_KEY)
1752 return -EOPNOTSUPP;
1753 return sd_pr_command(bdev, (flags & PR_FL_IGNORE_KEY) ? 0x06 : 0x00,
1754 old_key, new_key, 0,
1755 (1 << 0) /* APTPL */);
1758 static int sd_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
1759 u32 flags)
1761 if (flags)
1762 return -EOPNOTSUPP;
1763 return sd_pr_command(bdev, 0x01, key, 0, sd_pr_type(type), 0);
1766 static int sd_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1768 return sd_pr_command(bdev, 0x02, key, 0, sd_pr_type(type), 0);
1771 static int sd_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
1772 enum pr_type type, bool abort)
1774 return sd_pr_command(bdev, abort ? 0x05 : 0x04, old_key, new_key,
1775 sd_pr_type(type), 0);
1778 static int sd_pr_clear(struct block_device *bdev, u64 key)
1780 return sd_pr_command(bdev, 0x03, key, 0, 0, 0);
1783 static const struct pr_ops sd_pr_ops = {
1784 .pr_register = sd_pr_register,
1785 .pr_reserve = sd_pr_reserve,
1786 .pr_release = sd_pr_release,
1787 .pr_preempt = sd_pr_preempt,
1788 .pr_clear = sd_pr_clear,
1791 static const struct block_device_operations sd_fops = {
1792 .owner = THIS_MODULE,
1793 .open = sd_open,
1794 .release = sd_release,
1795 .ioctl = sd_ioctl,
1796 .getgeo = sd_getgeo,
1797 #ifdef CONFIG_COMPAT
1798 .compat_ioctl = sd_compat_ioctl,
1799 #endif
1800 .check_events = sd_check_events,
1801 .revalidate_disk = sd_revalidate_disk,
1802 .unlock_native_capacity = sd_unlock_native_capacity,
1803 .report_zones = sd_zbc_report_zones,
1804 .pr_ops = &sd_pr_ops,
1808 * sd_eh_reset - reset error handling callback
1809 * @scmd: sd-issued command that has failed
1811 * This function is called by the SCSI midlayer before starting
1812 * SCSI EH. When counting medium access failures we have to be
1813 * careful to register it only only once per device and SCSI EH run;
1814 * there might be several timed out commands which will cause the
1815 * 'max_medium_access_timeouts' counter to trigger after the first
1816 * SCSI EH run already and set the device to offline.
1817 * So this function resets the internal counter before starting SCSI EH.
1819 static void sd_eh_reset(struct scsi_cmnd *scmd)
1821 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1823 /* New SCSI EH run, reset gate variable */
1824 sdkp->ignore_medium_access_errors = false;
1828 * sd_eh_action - error handling callback
1829 * @scmd: sd-issued command that has failed
1830 * @eh_disp: The recovery disposition suggested by the midlayer
1832 * This function is called by the SCSI midlayer upon completion of an
1833 * error test command (currently TEST UNIT READY). The result of sending
1834 * the eh command is passed in eh_disp. We're looking for devices that
1835 * fail medium access commands but are OK with non access commands like
1836 * test unit ready (so wrongly see the device as having a successful
1837 * recovery)
1839 static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
1841 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1842 struct scsi_device *sdev = scmd->device;
1844 if (!scsi_device_online(sdev) ||
1845 !scsi_medium_access_command(scmd) ||
1846 host_byte(scmd->result) != DID_TIME_OUT ||
1847 eh_disp != SUCCESS)
1848 return eh_disp;
1851 * The device has timed out executing a medium access command.
1852 * However, the TEST UNIT READY command sent during error
1853 * handling completed successfully. Either the device is in the
1854 * process of recovering or has it suffered an internal failure
1855 * that prevents access to the storage medium.
1857 if (!sdkp->ignore_medium_access_errors) {
1858 sdkp->medium_access_timed_out++;
1859 sdkp->ignore_medium_access_errors = true;
1863 * If the device keeps failing read/write commands but TEST UNIT
1864 * READY always completes successfully we assume that medium
1865 * access is no longer possible and take the device offline.
1867 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1868 scmd_printk(KERN_ERR, scmd,
1869 "Medium access timeout failure. Offlining disk!\n");
1870 mutex_lock(&sdev->state_mutex);
1871 scsi_device_set_state(sdev, SDEV_OFFLINE);
1872 mutex_unlock(&sdev->state_mutex);
1874 return SUCCESS;
1877 return eh_disp;
1880 static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1882 struct request *req = scmd->request;
1883 struct scsi_device *sdev = scmd->device;
1884 unsigned int transferred, good_bytes;
1885 u64 start_lba, end_lba, bad_lba;
1888 * Some commands have a payload smaller than the device logical
1889 * block size (e.g. INQUIRY on a 4K disk).
1891 if (scsi_bufflen(scmd) <= sdev->sector_size)
1892 return 0;
1894 /* Check if we have a 'bad_lba' information */
1895 if (!scsi_get_sense_info_fld(scmd->sense_buffer,
1896 SCSI_SENSE_BUFFERSIZE,
1897 &bad_lba))
1898 return 0;
1901 * If the bad lba was reported incorrectly, we have no idea where
1902 * the error is.
1904 start_lba = sectors_to_logical(sdev, blk_rq_pos(req));
1905 end_lba = start_lba + bytes_to_logical(sdev, scsi_bufflen(scmd));
1906 if (bad_lba < start_lba || bad_lba >= end_lba)
1907 return 0;
1910 * resid is optional but mostly filled in. When it's unused,
1911 * its value is zero, so we assume the whole buffer transferred
1913 transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
1915 /* This computation should always be done in terms of the
1916 * resolution of the device's medium.
1918 good_bytes = logical_to_bytes(sdev, bad_lba - start_lba);
1920 return min(good_bytes, transferred);
1924 * sd_done - bottom half handler: called when the lower level
1925 * driver has completed (successfully or otherwise) a scsi command.
1926 * @SCpnt: mid-level's per command structure.
1928 * Note: potentially run from within an ISR. Must not block.
1930 static int sd_done(struct scsi_cmnd *SCpnt)
1932 int result = SCpnt->result;
1933 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
1934 unsigned int sector_size = SCpnt->device->sector_size;
1935 unsigned int resid;
1936 struct scsi_sense_hdr sshdr;
1937 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
1938 struct request *req = SCpnt->request;
1939 int sense_valid = 0;
1940 int sense_deferred = 0;
1942 switch (req_op(req)) {
1943 case REQ_OP_DISCARD:
1944 case REQ_OP_WRITE_ZEROES:
1945 case REQ_OP_WRITE_SAME:
1946 case REQ_OP_ZONE_RESET:
1947 if (!result) {
1948 good_bytes = blk_rq_bytes(req);
1949 scsi_set_resid(SCpnt, 0);
1950 } else {
1951 good_bytes = 0;
1952 scsi_set_resid(SCpnt, blk_rq_bytes(req));
1954 break;
1955 default:
1957 * In case of bogus fw or device, we could end up having
1958 * an unaligned partial completion. Check this here and force
1959 * alignment.
1961 resid = scsi_get_resid(SCpnt);
1962 if (resid & (sector_size - 1)) {
1963 sd_printk(KERN_INFO, sdkp,
1964 "Unaligned partial completion (resid=%u, sector_sz=%u)\n",
1965 resid, sector_size);
1966 resid = min(scsi_bufflen(SCpnt),
1967 round_up(resid, sector_size));
1968 scsi_set_resid(SCpnt, resid);
1972 if (result) {
1973 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1974 if (sense_valid)
1975 sense_deferred = scsi_sense_is_deferred(&sshdr);
1977 sdkp->medium_access_timed_out = 0;
1979 if (driver_byte(result) != DRIVER_SENSE &&
1980 (!sense_valid || sense_deferred))
1981 goto out;
1983 switch (sshdr.sense_key) {
1984 case HARDWARE_ERROR:
1985 case MEDIUM_ERROR:
1986 good_bytes = sd_completed_bytes(SCpnt);
1987 break;
1988 case RECOVERED_ERROR:
1989 good_bytes = scsi_bufflen(SCpnt);
1990 break;
1991 case NO_SENSE:
1992 /* This indicates a false check condition, so ignore it. An
1993 * unknown amount of data was transferred so treat it as an
1994 * error.
1996 SCpnt->result = 0;
1997 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1998 break;
1999 case ABORTED_COMMAND:
2000 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
2001 good_bytes = sd_completed_bytes(SCpnt);
2002 break;
2003 case ILLEGAL_REQUEST:
2004 switch (sshdr.asc) {
2005 case 0x10: /* DIX: Host detected corruption */
2006 good_bytes = sd_completed_bytes(SCpnt);
2007 break;
2008 case 0x20: /* INVALID COMMAND OPCODE */
2009 case 0x24: /* INVALID FIELD IN CDB */
2010 switch (SCpnt->cmnd[0]) {
2011 case UNMAP:
2012 sd_config_discard(sdkp, SD_LBP_DISABLE);
2013 break;
2014 case WRITE_SAME_16:
2015 case WRITE_SAME:
2016 if (SCpnt->cmnd[1] & 8) { /* UNMAP */
2017 sd_config_discard(sdkp, SD_LBP_DISABLE);
2018 } else {
2019 sdkp->device->no_write_same = 1;
2020 sd_config_write_same(sdkp);
2021 req->rq_flags |= RQF_QUIET;
2023 break;
2026 break;
2027 default:
2028 break;
2031 out:
2032 if (sd_is_zoned(sdkp))
2033 sd_zbc_complete(SCpnt, good_bytes, &sshdr);
2035 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
2036 "sd_done: completed %d of %d bytes\n",
2037 good_bytes, scsi_bufflen(SCpnt)));
2039 if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt) &&
2040 good_bytes)
2041 t10_pi_complete(SCpnt->request, sdkp->protection_type,
2042 good_bytes / scsi_prot_interval(SCpnt));
2044 return good_bytes;
2048 * spinup disk - called only in sd_revalidate_disk()
2050 static void
2051 sd_spinup_disk(struct scsi_disk *sdkp)
2053 unsigned char cmd[10];
2054 unsigned long spintime_expire = 0;
2055 int retries, spintime;
2056 unsigned int the_result;
2057 struct scsi_sense_hdr sshdr;
2058 int sense_valid = 0;
2060 spintime = 0;
2062 /* Spin up drives, as required. Only do this at boot time */
2063 /* Spinup needs to be done for module loads too. */
2064 do {
2065 retries = 0;
2067 do {
2068 cmd[0] = TEST_UNIT_READY;
2069 memset((void *) &cmd[1], 0, 9);
2071 the_result = scsi_execute_req(sdkp->device, cmd,
2072 DMA_NONE, NULL, 0,
2073 &sshdr, SD_TIMEOUT,
2074 SD_MAX_RETRIES, NULL);
2077 * If the drive has indicated to us that it
2078 * doesn't have any media in it, don't bother
2079 * with any more polling.
2081 if (media_not_present(sdkp, &sshdr))
2082 return;
2084 if (the_result)
2085 sense_valid = scsi_sense_valid(&sshdr);
2086 retries++;
2087 } while (retries < 3 &&
2088 (!scsi_status_is_good(the_result) ||
2089 ((driver_byte(the_result) == DRIVER_SENSE) &&
2090 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
2092 if (driver_byte(the_result) != DRIVER_SENSE) {
2093 /* no sense, TUR either succeeded or failed
2094 * with a status error */
2095 if(!spintime && !scsi_status_is_good(the_result)) {
2096 sd_print_result(sdkp, "Test Unit Ready failed",
2097 the_result);
2099 break;
2103 * The device does not want the automatic start to be issued.
2105 if (sdkp->device->no_start_on_add)
2106 break;
2108 if (sense_valid && sshdr.sense_key == NOT_READY) {
2109 if (sshdr.asc == 4 && sshdr.ascq == 3)
2110 break; /* manual intervention required */
2111 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
2112 break; /* standby */
2113 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
2114 break; /* unavailable */
2115 if (sshdr.asc == 4 && sshdr.ascq == 0x1b)
2116 break; /* sanitize in progress */
2118 * Issue command to spin up drive when not ready
2120 if (!spintime) {
2121 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
2122 cmd[0] = START_STOP;
2123 cmd[1] = 1; /* Return immediately */
2124 memset((void *) &cmd[2], 0, 8);
2125 cmd[4] = 1; /* Start spin cycle */
2126 if (sdkp->device->start_stop_pwr_cond)
2127 cmd[4] |= 1 << 4;
2128 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
2129 NULL, 0, &sshdr,
2130 SD_TIMEOUT, SD_MAX_RETRIES,
2131 NULL);
2132 spintime_expire = jiffies + 100 * HZ;
2133 spintime = 1;
2135 /* Wait 1 second for next try */
2136 msleep(1000);
2137 printk(KERN_CONT ".");
2140 * Wait for USB flash devices with slow firmware.
2141 * Yes, this sense key/ASC combination shouldn't
2142 * occur here. It's characteristic of these devices.
2144 } else if (sense_valid &&
2145 sshdr.sense_key == UNIT_ATTENTION &&
2146 sshdr.asc == 0x28) {
2147 if (!spintime) {
2148 spintime_expire = jiffies + 5 * HZ;
2149 spintime = 1;
2151 /* Wait 1 second for next try */
2152 msleep(1000);
2153 } else {
2154 /* we don't understand the sense code, so it's
2155 * probably pointless to loop */
2156 if(!spintime) {
2157 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
2158 sd_print_sense_hdr(sdkp, &sshdr);
2160 break;
2163 } while (spintime && time_before_eq(jiffies, spintime_expire));
2165 if (spintime) {
2166 if (scsi_status_is_good(the_result))
2167 printk(KERN_CONT "ready\n");
2168 else
2169 printk(KERN_CONT "not responding...\n");
2174 * Determine whether disk supports Data Integrity Field.
2176 static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
2178 struct scsi_device *sdp = sdkp->device;
2179 u8 type;
2180 int ret = 0;
2182 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
2183 return ret;
2185 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
2187 if (type > T10_PI_TYPE3_PROTECTION)
2188 ret = -ENODEV;
2189 else if (scsi_host_dif_capable(sdp->host, type))
2190 ret = 1;
2192 if (sdkp->first_scan || type != sdkp->protection_type)
2193 switch (ret) {
2194 case -ENODEV:
2195 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
2196 " protection type %u. Disabling disk!\n",
2197 type);
2198 break;
2199 case 1:
2200 sd_printk(KERN_NOTICE, sdkp,
2201 "Enabling DIF Type %u protection\n", type);
2202 break;
2203 case 0:
2204 sd_printk(KERN_NOTICE, sdkp,
2205 "Disabling DIF Type %u protection\n", type);
2206 break;
2209 sdkp->protection_type = type;
2211 return ret;
2214 static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
2215 struct scsi_sense_hdr *sshdr, int sense_valid,
2216 int the_result)
2218 if (driver_byte(the_result) == DRIVER_SENSE)
2219 sd_print_sense_hdr(sdkp, sshdr);
2220 else
2221 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
2224 * Set dirty bit for removable devices if not ready -
2225 * sometimes drives will not report this properly.
2227 if (sdp->removable &&
2228 sense_valid && sshdr->sense_key == NOT_READY)
2229 set_media_not_present(sdkp);
2232 * We used to set media_present to 0 here to indicate no media
2233 * in the drive, but some drives fail read capacity even with
2234 * media present, so we can't do that.
2236 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
2239 #define RC16_LEN 32
2240 #if RC16_LEN > SD_BUF_SIZE
2241 #error RC16_LEN must not be more than SD_BUF_SIZE
2242 #endif
2244 #define READ_CAPACITY_RETRIES_ON_RESET 10
2247 * Ensure that we don't overflow sector_t when CONFIG_LBDAF is not set
2248 * and the reported logical block size is bigger than 512 bytes. Note
2249 * that last_sector is a u64 and therefore logical_to_sectors() is not
2250 * applicable.
2252 static bool sd_addressable_capacity(u64 lba, unsigned int sector_size)
2254 u64 last_sector = (lba + 1ULL) << (ilog2(sector_size) - 9);
2256 if (sizeof(sector_t) == 4 && last_sector > U32_MAX)
2257 return false;
2259 return true;
2262 static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
2263 unsigned char *buffer)
2265 unsigned char cmd[16];
2266 struct scsi_sense_hdr sshdr;
2267 int sense_valid = 0;
2268 int the_result;
2269 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2270 unsigned int alignment;
2271 unsigned long long lba;
2272 unsigned sector_size;
2274 if (sdp->no_read_capacity_16)
2275 return -EINVAL;
2277 do {
2278 memset(cmd, 0, 16);
2279 cmd[0] = SERVICE_ACTION_IN_16;
2280 cmd[1] = SAI_READ_CAPACITY_16;
2281 cmd[13] = RC16_LEN;
2282 memset(buffer, 0, RC16_LEN);
2284 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2285 buffer, RC16_LEN, &sshdr,
2286 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2288 if (media_not_present(sdkp, &sshdr))
2289 return -ENODEV;
2291 if (the_result) {
2292 sense_valid = scsi_sense_valid(&sshdr);
2293 if (sense_valid &&
2294 sshdr.sense_key == ILLEGAL_REQUEST &&
2295 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
2296 sshdr.ascq == 0x00)
2297 /* Invalid Command Operation Code or
2298 * Invalid Field in CDB, just retry
2299 * silently with RC10 */
2300 return -EINVAL;
2301 if (sense_valid &&
2302 sshdr.sense_key == UNIT_ATTENTION &&
2303 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2304 /* Device reset might occur several times,
2305 * give it one more chance */
2306 if (--reset_retries > 0)
2307 continue;
2309 retries--;
2311 } while (the_result && retries);
2313 if (the_result) {
2314 sd_print_result(sdkp, "Read Capacity(16) failed", the_result);
2315 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2316 return -EINVAL;
2319 sector_size = get_unaligned_be32(&buffer[8]);
2320 lba = get_unaligned_be64(&buffer[0]);
2322 if (sd_read_protection_type(sdkp, buffer) < 0) {
2323 sdkp->capacity = 0;
2324 return -ENODEV;
2327 if (!sd_addressable_capacity(lba, sector_size)) {
2328 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2329 "kernel compiled with support for large block "
2330 "devices.\n");
2331 sdkp->capacity = 0;
2332 return -EOVERFLOW;
2335 /* Logical blocks per physical block exponent */
2336 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
2338 /* RC basis */
2339 sdkp->rc_basis = (buffer[12] >> 4) & 0x3;
2341 /* Lowest aligned logical block */
2342 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2343 blk_queue_alignment_offset(sdp->request_queue, alignment);
2344 if (alignment && sdkp->first_scan)
2345 sd_printk(KERN_NOTICE, sdkp,
2346 "physical block alignment offset: %u\n", alignment);
2348 if (buffer[14] & 0x80) { /* LBPME */
2349 sdkp->lbpme = 1;
2351 if (buffer[14] & 0x40) /* LBPRZ */
2352 sdkp->lbprz = 1;
2354 sd_config_discard(sdkp, SD_LBP_WS16);
2357 sdkp->capacity = lba + 1;
2358 return sector_size;
2361 static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2362 unsigned char *buffer)
2364 unsigned char cmd[16];
2365 struct scsi_sense_hdr sshdr;
2366 int sense_valid = 0;
2367 int the_result;
2368 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2369 sector_t lba;
2370 unsigned sector_size;
2372 do {
2373 cmd[0] = READ_CAPACITY;
2374 memset(&cmd[1], 0, 9);
2375 memset(buffer, 0, 8);
2377 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2378 buffer, 8, &sshdr,
2379 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2381 if (media_not_present(sdkp, &sshdr))
2382 return -ENODEV;
2384 if (the_result) {
2385 sense_valid = scsi_sense_valid(&sshdr);
2386 if (sense_valid &&
2387 sshdr.sense_key == UNIT_ATTENTION &&
2388 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2389 /* Device reset might occur several times,
2390 * give it one more chance */
2391 if (--reset_retries > 0)
2392 continue;
2394 retries--;
2396 } while (the_result && retries);
2398 if (the_result) {
2399 sd_print_result(sdkp, "Read Capacity(10) failed", the_result);
2400 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2401 return -EINVAL;
2404 sector_size = get_unaligned_be32(&buffer[4]);
2405 lba = get_unaligned_be32(&buffer[0]);
2407 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2408 /* Some buggy (usb cardreader) devices return an lba of
2409 0xffffffff when the want to report a size of 0 (with
2410 which they really mean no media is present) */
2411 sdkp->capacity = 0;
2412 sdkp->physical_block_size = sector_size;
2413 return sector_size;
2416 if (!sd_addressable_capacity(lba, sector_size)) {
2417 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2418 "kernel compiled with support for large block "
2419 "devices.\n");
2420 sdkp->capacity = 0;
2421 return -EOVERFLOW;
2424 sdkp->capacity = lba + 1;
2425 sdkp->physical_block_size = sector_size;
2426 return sector_size;
2429 static int sd_try_rc16_first(struct scsi_device *sdp)
2431 if (sdp->host->max_cmd_len < 16)
2432 return 0;
2433 if (sdp->try_rc_10_first)
2434 return 0;
2435 if (sdp->scsi_level > SCSI_SPC_2)
2436 return 1;
2437 if (scsi_device_protection(sdp))
2438 return 1;
2439 return 0;
2443 * read disk capacity
2445 static void
2446 sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2448 int sector_size;
2449 struct scsi_device *sdp = sdkp->device;
2451 if (sd_try_rc16_first(sdp)) {
2452 sector_size = read_capacity_16(sdkp, sdp, buffer);
2453 if (sector_size == -EOVERFLOW)
2454 goto got_data;
2455 if (sector_size == -ENODEV)
2456 return;
2457 if (sector_size < 0)
2458 sector_size = read_capacity_10(sdkp, sdp, buffer);
2459 if (sector_size < 0)
2460 return;
2461 } else {
2462 sector_size = read_capacity_10(sdkp, sdp, buffer);
2463 if (sector_size == -EOVERFLOW)
2464 goto got_data;
2465 if (sector_size < 0)
2466 return;
2467 if ((sizeof(sdkp->capacity) > 4) &&
2468 (sdkp->capacity > 0xffffffffULL)) {
2469 int old_sector_size = sector_size;
2470 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2471 "Trying to use READ CAPACITY(16).\n");
2472 sector_size = read_capacity_16(sdkp, sdp, buffer);
2473 if (sector_size < 0) {
2474 sd_printk(KERN_NOTICE, sdkp,
2475 "Using 0xffffffff as device size\n");
2476 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2477 sector_size = old_sector_size;
2478 goto got_data;
2480 /* Remember that READ CAPACITY(16) succeeded */
2481 sdp->try_rc_10_first = 0;
2485 /* Some devices are known to return the total number of blocks,
2486 * not the highest block number. Some devices have versions
2487 * which do this and others which do not. Some devices we might
2488 * suspect of doing this but we don't know for certain.
2490 * If we know the reported capacity is wrong, decrement it. If
2491 * we can only guess, then assume the number of blocks is even
2492 * (usually true but not always) and err on the side of lowering
2493 * the capacity.
2495 if (sdp->fix_capacity ||
2496 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2497 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2498 "from its reported value: %llu\n",
2499 (unsigned long long) sdkp->capacity);
2500 --sdkp->capacity;
2503 got_data:
2504 if (sector_size == 0) {
2505 sector_size = 512;
2506 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2507 "assuming 512.\n");
2510 if (sector_size != 512 &&
2511 sector_size != 1024 &&
2512 sector_size != 2048 &&
2513 sector_size != 4096) {
2514 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2515 sector_size);
2517 * The user might want to re-format the drive with
2518 * a supported sectorsize. Once this happens, it
2519 * would be relatively trivial to set the thing up.
2520 * For this reason, we leave the thing in the table.
2522 sdkp->capacity = 0;
2524 * set a bogus sector size so the normal read/write
2525 * logic in the block layer will eventually refuse any
2526 * request on this device without tripping over power
2527 * of two sector size assumptions
2529 sector_size = 512;
2531 blk_queue_logical_block_size(sdp->request_queue, sector_size);
2532 blk_queue_physical_block_size(sdp->request_queue,
2533 sdkp->physical_block_size);
2534 sdkp->device->sector_size = sector_size;
2536 if (sdkp->capacity > 0xffffffff)
2537 sdp->use_16_for_rw = 1;
2542 * Print disk capacity
2544 static void
2545 sd_print_capacity(struct scsi_disk *sdkp,
2546 sector_t old_capacity)
2548 int sector_size = sdkp->device->sector_size;
2549 char cap_str_2[10], cap_str_10[10];
2551 string_get_size(sdkp->capacity, sector_size,
2552 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
2553 string_get_size(sdkp->capacity, sector_size,
2554 STRING_UNITS_10, cap_str_10,
2555 sizeof(cap_str_10));
2557 if (sdkp->first_scan || old_capacity != sdkp->capacity) {
2558 sd_printk(KERN_NOTICE, sdkp,
2559 "%llu %d-byte logical blocks: (%s/%s)\n",
2560 (unsigned long long)sdkp->capacity,
2561 sector_size, cap_str_10, cap_str_2);
2563 if (sdkp->physical_block_size != sector_size)
2564 sd_printk(KERN_NOTICE, sdkp,
2565 "%u-byte physical blocks\n",
2566 sdkp->physical_block_size);
2568 sd_zbc_print_zones(sdkp);
2572 /* called with buffer of length 512 */
2573 static inline int
2574 sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
2575 unsigned char *buffer, int len, struct scsi_mode_data *data,
2576 struct scsi_sense_hdr *sshdr)
2578 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
2579 SD_TIMEOUT, SD_MAX_RETRIES, data,
2580 sshdr);
2584 * read write protect setting, if possible - called only in sd_revalidate_disk()
2585 * called with buffer of length SD_BUF_SIZE
2587 static void
2588 sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
2590 int res;
2591 struct scsi_device *sdp = sdkp->device;
2592 struct scsi_mode_data data;
2593 int disk_ro = get_disk_ro(sdkp->disk);
2594 int old_wp = sdkp->write_prot;
2596 set_disk_ro(sdkp->disk, 0);
2597 if (sdp->skip_ms_page_3f) {
2598 sd_first_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
2599 return;
2602 if (sdp->use_192_bytes_for_3f) {
2603 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
2604 } else {
2606 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2607 * We have to start carefully: some devices hang if we ask
2608 * for more than is available.
2610 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
2613 * Second attempt: ask for page 0 When only page 0 is
2614 * implemented, a request for page 3F may return Sense Key
2615 * 5: Illegal Request, Sense Code 24: Invalid field in
2616 * CDB.
2618 if (!scsi_status_is_good(res))
2619 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
2622 * Third attempt: ask 255 bytes, as we did earlier.
2624 if (!scsi_status_is_good(res))
2625 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
2626 &data, NULL);
2629 if (!scsi_status_is_good(res)) {
2630 sd_first_printk(KERN_WARNING, sdkp,
2631 "Test WP failed, assume Write Enabled\n");
2632 } else {
2633 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
2634 set_disk_ro(sdkp->disk, sdkp->write_prot || disk_ro);
2635 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2636 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2637 sdkp->write_prot ? "on" : "off");
2638 sd_printk(KERN_DEBUG, sdkp, "Mode Sense: %4ph\n", buffer);
2644 * sd_read_cache_type - called only from sd_revalidate_disk()
2645 * called with buffer of length SD_BUF_SIZE
2647 static void
2648 sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
2650 int len = 0, res;
2651 struct scsi_device *sdp = sdkp->device;
2653 int dbd;
2654 int modepage;
2655 int first_len;
2656 struct scsi_mode_data data;
2657 struct scsi_sense_hdr sshdr;
2658 int old_wce = sdkp->WCE;
2659 int old_rcd = sdkp->RCD;
2660 int old_dpofua = sdkp->DPOFUA;
2663 if (sdkp->cache_override)
2664 return;
2666 first_len = 4;
2667 if (sdp->skip_ms_page_8) {
2668 if (sdp->type == TYPE_RBC)
2669 goto defaults;
2670 else {
2671 if (sdp->skip_ms_page_3f)
2672 goto defaults;
2673 modepage = 0x3F;
2674 if (sdp->use_192_bytes_for_3f)
2675 first_len = 192;
2676 dbd = 0;
2678 } else if (sdp->type == TYPE_RBC) {
2679 modepage = 6;
2680 dbd = 8;
2681 } else {
2682 modepage = 8;
2683 dbd = 0;
2686 /* cautiously ask */
2687 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2688 &data, &sshdr);
2690 if (!scsi_status_is_good(res))
2691 goto bad_sense;
2693 if (!data.header_length) {
2694 modepage = 6;
2695 first_len = 0;
2696 sd_first_printk(KERN_ERR, sdkp,
2697 "Missing header in MODE_SENSE response\n");
2700 /* that went OK, now ask for the proper length */
2701 len = data.length;
2704 * We're only interested in the first three bytes, actually.
2705 * But the data cache page is defined for the first 20.
2707 if (len < 3)
2708 goto bad_sense;
2709 else if (len > SD_BUF_SIZE) {
2710 sd_first_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
2711 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2712 len = SD_BUF_SIZE;
2714 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2715 len = 192;
2717 /* Get the data */
2718 if (len > first_len)
2719 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2720 &data, &sshdr);
2722 if (scsi_status_is_good(res)) {
2723 int offset = data.header_length + data.block_descriptor_length;
2725 while (offset < len) {
2726 u8 page_code = buffer[offset] & 0x3F;
2727 u8 spf = buffer[offset] & 0x40;
2729 if (page_code == 8 || page_code == 6) {
2730 /* We're interested only in the first 3 bytes.
2732 if (len - offset <= 2) {
2733 sd_first_printk(KERN_ERR, sdkp,
2734 "Incomplete mode parameter "
2735 "data\n");
2736 goto defaults;
2737 } else {
2738 modepage = page_code;
2739 goto Page_found;
2741 } else {
2742 /* Go to the next page */
2743 if (spf && len - offset > 3)
2744 offset += 4 + (buffer[offset+2] << 8) +
2745 buffer[offset+3];
2746 else if (!spf && len - offset > 1)
2747 offset += 2 + buffer[offset+1];
2748 else {
2749 sd_first_printk(KERN_ERR, sdkp,
2750 "Incomplete mode "
2751 "parameter data\n");
2752 goto defaults;
2757 sd_first_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
2758 goto defaults;
2760 Page_found:
2761 if (modepage == 8) {
2762 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2763 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2764 } else {
2765 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2766 sdkp->RCD = 0;
2769 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
2770 if (sdp->broken_fua) {
2771 sd_first_printk(KERN_NOTICE, sdkp, "Disabling FUA\n");
2772 sdkp->DPOFUA = 0;
2773 } else if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw &&
2774 !sdkp->device->use_16_for_rw) {
2775 sd_first_printk(KERN_NOTICE, sdkp,
2776 "Uses READ/WRITE(6), disabling FUA\n");
2777 sdkp->DPOFUA = 0;
2780 /* No cache flush allowed for write protected devices */
2781 if (sdkp->WCE && sdkp->write_prot)
2782 sdkp->WCE = 0;
2784 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2785 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2786 sd_printk(KERN_NOTICE, sdkp,
2787 "Write cache: %s, read cache: %s, %s\n",
2788 sdkp->WCE ? "enabled" : "disabled",
2789 sdkp->RCD ? "disabled" : "enabled",
2790 sdkp->DPOFUA ? "supports DPO and FUA"
2791 : "doesn't support DPO or FUA");
2793 return;
2796 bad_sense:
2797 if (scsi_sense_valid(&sshdr) &&
2798 sshdr.sense_key == ILLEGAL_REQUEST &&
2799 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
2800 /* Invalid field in CDB */
2801 sd_first_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
2802 else
2803 sd_first_printk(KERN_ERR, sdkp,
2804 "Asking for cache data failed\n");
2806 defaults:
2807 if (sdp->wce_default_on) {
2808 sd_first_printk(KERN_NOTICE, sdkp,
2809 "Assuming drive cache: write back\n");
2810 sdkp->WCE = 1;
2811 } else {
2812 sd_first_printk(KERN_ERR, sdkp,
2813 "Assuming drive cache: write through\n");
2814 sdkp->WCE = 0;
2816 sdkp->RCD = 0;
2817 sdkp->DPOFUA = 0;
2821 * The ATO bit indicates whether the DIF application tag is available
2822 * for use by the operating system.
2824 static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
2826 int res, offset;
2827 struct scsi_device *sdp = sdkp->device;
2828 struct scsi_mode_data data;
2829 struct scsi_sense_hdr sshdr;
2831 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
2832 return;
2834 if (sdkp->protection_type == 0)
2835 return;
2837 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2838 SD_MAX_RETRIES, &data, &sshdr);
2840 if (!scsi_status_is_good(res) || !data.header_length ||
2841 data.length < 6) {
2842 sd_first_printk(KERN_WARNING, sdkp,
2843 "getting Control mode page failed, assume no ATO\n");
2845 if (scsi_sense_valid(&sshdr))
2846 sd_print_sense_hdr(sdkp, &sshdr);
2848 return;
2851 offset = data.header_length + data.block_descriptor_length;
2853 if ((buffer[offset] & 0x3f) != 0x0a) {
2854 sd_first_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
2855 return;
2858 if ((buffer[offset + 5] & 0x80) == 0)
2859 return;
2861 sdkp->ATO = 1;
2863 return;
2867 * sd_read_block_limits - Query disk device for preferred I/O sizes.
2868 * @sdkp: disk to query
2870 static void sd_read_block_limits(struct scsi_disk *sdkp)
2872 unsigned int sector_sz = sdkp->device->sector_size;
2873 const int vpd_len = 64;
2874 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
2876 if (!buffer ||
2877 /* Block Limits VPD */
2878 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2879 goto out;
2881 blk_queue_io_min(sdkp->disk->queue,
2882 get_unaligned_be16(&buffer[6]) * sector_sz);
2884 sdkp->max_xfer_blocks = get_unaligned_be32(&buffer[8]);
2885 sdkp->opt_xfer_blocks = get_unaligned_be32(&buffer[12]);
2887 if (buffer[3] == 0x3c) {
2888 unsigned int lba_count, desc_count;
2890 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
2892 if (!sdkp->lbpme)
2893 goto out;
2895 lba_count = get_unaligned_be32(&buffer[20]);
2896 desc_count = get_unaligned_be32(&buffer[24]);
2898 if (lba_count && desc_count)
2899 sdkp->max_unmap_blocks = lba_count;
2901 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
2903 if (buffer[32] & 0x80)
2904 sdkp->unmap_alignment =
2905 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
2907 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2909 if (sdkp->max_unmap_blocks)
2910 sd_config_discard(sdkp, SD_LBP_UNMAP);
2911 else
2912 sd_config_discard(sdkp, SD_LBP_WS16);
2914 } else { /* LBP VPD page tells us what to use */
2915 if (sdkp->lbpu && sdkp->max_unmap_blocks)
2916 sd_config_discard(sdkp, SD_LBP_UNMAP);
2917 else if (sdkp->lbpws)
2918 sd_config_discard(sdkp, SD_LBP_WS16);
2919 else if (sdkp->lbpws10)
2920 sd_config_discard(sdkp, SD_LBP_WS10);
2921 else
2922 sd_config_discard(sdkp, SD_LBP_DISABLE);
2926 out:
2927 kfree(buffer);
2931 * sd_read_block_characteristics - Query block dev. characteristics
2932 * @sdkp: disk to query
2934 static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2936 struct request_queue *q = sdkp->disk->queue;
2937 unsigned char *buffer;
2938 u16 rot;
2939 const int vpd_len = 64;
2941 buffer = kmalloc(vpd_len, GFP_KERNEL);
2943 if (!buffer ||
2944 /* Block Device Characteristics VPD */
2945 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2946 goto out;
2948 rot = get_unaligned_be16(&buffer[4]);
2950 if (rot == 1) {
2951 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
2952 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, q);
2953 } else {
2954 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
2955 blk_queue_flag_set(QUEUE_FLAG_ADD_RANDOM, q);
2958 if (sdkp->device->type == TYPE_ZBC) {
2959 /* Host-managed */
2960 q->limits.zoned = BLK_ZONED_HM;
2961 } else {
2962 sdkp->zoned = (buffer[8] >> 4) & 3;
2963 if (sdkp->zoned == 1)
2964 /* Host-aware */
2965 q->limits.zoned = BLK_ZONED_HA;
2966 else
2968 * Treat drive-managed devices as
2969 * regular block devices.
2971 q->limits.zoned = BLK_ZONED_NONE;
2973 if (blk_queue_is_zoned(q) && sdkp->first_scan)
2974 sd_printk(KERN_NOTICE, sdkp, "Host-%s zoned block device\n",
2975 q->limits.zoned == BLK_ZONED_HM ? "managed" : "aware");
2977 out:
2978 kfree(buffer);
2982 * sd_read_block_provisioning - Query provisioning VPD page
2983 * @sdkp: disk to query
2985 static void sd_read_block_provisioning(struct scsi_disk *sdkp)
2987 unsigned char *buffer;
2988 const int vpd_len = 8;
2990 if (sdkp->lbpme == 0)
2991 return;
2993 buffer = kmalloc(vpd_len, GFP_KERNEL);
2995 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
2996 goto out;
2998 sdkp->lbpvpd = 1;
2999 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
3000 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
3001 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
3003 out:
3004 kfree(buffer);
3007 static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
3009 struct scsi_device *sdev = sdkp->device;
3011 if (sdev->host->no_write_same) {
3012 sdev->no_write_same = 1;
3014 return;
3017 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
3018 /* too large values might cause issues with arcmsr */
3019 int vpd_buf_len = 64;
3021 sdev->no_report_opcodes = 1;
3023 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
3024 * CODES is unsupported and the device has an ATA
3025 * Information VPD page (SAT).
3027 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
3028 sdev->no_write_same = 1;
3031 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
3032 sdkp->ws16 = 1;
3034 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
3035 sdkp->ws10 = 1;
3038 static void sd_read_security(struct scsi_disk *sdkp, unsigned char *buffer)
3040 struct scsi_device *sdev = sdkp->device;
3042 if (!sdev->security_supported)
3043 return;
3045 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3046 SECURITY_PROTOCOL_IN) == 1 &&
3047 scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3048 SECURITY_PROTOCOL_OUT) == 1)
3049 sdkp->security = 1;
3053 * sd_revalidate_disk - called the first time a new disk is seen,
3054 * performs disk spin up, read_capacity, etc.
3055 * @disk: struct gendisk we care about
3057 static int sd_revalidate_disk(struct gendisk *disk)
3059 struct scsi_disk *sdkp = scsi_disk(disk);
3060 struct scsi_device *sdp = sdkp->device;
3061 struct request_queue *q = sdkp->disk->queue;
3062 sector_t old_capacity = sdkp->capacity;
3063 unsigned char *buffer;
3064 unsigned int dev_max, rw_max;
3066 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
3067 "sd_revalidate_disk\n"));
3070 * If the device is offline, don't try and read capacity or any
3071 * of the other niceties.
3073 if (!scsi_device_online(sdp))
3074 goto out;
3076 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
3077 if (!buffer) {
3078 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
3079 "allocation failure.\n");
3080 goto out;
3083 sd_spinup_disk(sdkp);
3086 * Without media there is no reason to ask; moreover, some devices
3087 * react badly if we do.
3089 if (sdkp->media_present) {
3090 sd_read_capacity(sdkp, buffer);
3092 if (scsi_device_supports_vpd(sdp)) {
3093 sd_read_block_provisioning(sdkp);
3094 sd_read_block_limits(sdkp);
3095 sd_read_block_characteristics(sdkp);
3096 sd_zbc_read_zones(sdkp, buffer);
3099 sd_print_capacity(sdkp, old_capacity);
3101 sd_read_write_protect_flag(sdkp, buffer);
3102 sd_read_cache_type(sdkp, buffer);
3103 sd_read_app_tag_own(sdkp, buffer);
3104 sd_read_write_same(sdkp, buffer);
3105 sd_read_security(sdkp, buffer);
3109 * We now have all cache related info, determine how we deal
3110 * with flush requests.
3112 sd_set_flush_flag(sdkp);
3114 /* Initial block count limit based on CDB TRANSFER LENGTH field size. */
3115 dev_max = sdp->use_16_for_rw ? SD_MAX_XFER_BLOCKS : SD_DEF_XFER_BLOCKS;
3117 /* Some devices report a maximum block count for READ/WRITE requests. */
3118 dev_max = min_not_zero(dev_max, sdkp->max_xfer_blocks);
3119 q->limits.max_dev_sectors = logical_to_sectors(sdp, dev_max);
3122 * Determine the device's preferred I/O size for reads and writes
3123 * unless the reported value is unreasonably small, large, or
3124 * garbage.
3126 if (sdkp->opt_xfer_blocks &&
3127 sdkp->opt_xfer_blocks <= dev_max &&
3128 sdkp->opt_xfer_blocks <= SD_DEF_XFER_BLOCKS &&
3129 logical_to_bytes(sdp, sdkp->opt_xfer_blocks) >= PAGE_SIZE) {
3130 q->limits.io_opt = logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3131 rw_max = logical_to_sectors(sdp, sdkp->opt_xfer_blocks);
3132 } else
3133 rw_max = min_not_zero(logical_to_sectors(sdp, dev_max),
3134 (sector_t)BLK_DEF_MAX_SECTORS);
3136 /* Do not exceed controller limit */
3137 rw_max = min(rw_max, queue_max_hw_sectors(q));
3140 * Only update max_sectors if previously unset or if the current value
3141 * exceeds the capabilities of the hardware.
3143 if (sdkp->first_scan ||
3144 q->limits.max_sectors > q->limits.max_dev_sectors ||
3145 q->limits.max_sectors > q->limits.max_hw_sectors)
3146 q->limits.max_sectors = rw_max;
3148 sdkp->first_scan = 0;
3150 set_capacity(disk, logical_to_sectors(sdp, sdkp->capacity));
3151 sd_config_write_same(sdkp);
3152 kfree(buffer);
3154 out:
3155 return 0;
3159 * sd_unlock_native_capacity - unlock native capacity
3160 * @disk: struct gendisk to set capacity for
3162 * Block layer calls this function if it detects that partitions
3163 * on @disk reach beyond the end of the device. If the SCSI host
3164 * implements ->unlock_native_capacity() method, it's invoked to
3165 * give it a chance to adjust the device capacity.
3167 * CONTEXT:
3168 * Defined by block layer. Might sleep.
3170 static void sd_unlock_native_capacity(struct gendisk *disk)
3172 struct scsi_device *sdev = scsi_disk(disk)->device;
3174 if (sdev->host->hostt->unlock_native_capacity)
3175 sdev->host->hostt->unlock_native_capacity(sdev);
3179 * sd_format_disk_name - format disk name
3180 * @prefix: name prefix - ie. "sd" for SCSI disks
3181 * @index: index of the disk to format name for
3182 * @buf: output buffer
3183 * @buflen: length of the output buffer
3185 * SCSI disk names starts at sda. The 26th device is sdz and the
3186 * 27th is sdaa. The last one for two lettered suffix is sdzz
3187 * which is followed by sdaaa.
3189 * This is basically 26 base counting with one extra 'nil' entry
3190 * at the beginning from the second digit on and can be
3191 * determined using similar method as 26 base conversion with the
3192 * index shifted -1 after each digit is computed.
3194 * CONTEXT:
3195 * Don't care.
3197 * RETURNS:
3198 * 0 on success, -errno on failure.
3200 static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
3202 const int base = 'z' - 'a' + 1;
3203 char *begin = buf + strlen(prefix);
3204 char *end = buf + buflen;
3205 char *p;
3206 int unit;
3208 p = end - 1;
3209 *p = '\0';
3210 unit = base;
3211 do {
3212 if (p == begin)
3213 return -EINVAL;
3214 *--p = 'a' + (index % unit);
3215 index = (index / unit) - 1;
3216 } while (index >= 0);
3218 memmove(begin, p, end - p);
3219 memcpy(buf, prefix, strlen(prefix));
3221 return 0;
3225 * The asynchronous part of sd_probe
3227 static void sd_probe_async(void *data, async_cookie_t cookie)
3229 struct scsi_disk *sdkp = data;
3230 struct scsi_device *sdp;
3231 struct gendisk *gd;
3232 u32 index;
3233 struct device *dev;
3235 sdp = sdkp->device;
3236 gd = sdkp->disk;
3237 index = sdkp->index;
3238 dev = &sdp->sdev_gendev;
3240 gd->major = sd_major((index & 0xf0) >> 4);
3241 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
3243 gd->fops = &sd_fops;
3244 gd->private_data = &sdkp->driver;
3245 gd->queue = sdkp->device->request_queue;
3247 /* defaults, until the device tells us otherwise */
3248 sdp->sector_size = 512;
3249 sdkp->capacity = 0;
3250 sdkp->media_present = 1;
3251 sdkp->write_prot = 0;
3252 sdkp->cache_override = 0;
3253 sdkp->WCE = 0;
3254 sdkp->RCD = 0;
3255 sdkp->ATO = 0;
3256 sdkp->first_scan = 1;
3257 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
3259 sd_revalidate_disk(gd);
3261 gd->flags = GENHD_FL_EXT_DEVT;
3262 if (sdp->removable) {
3263 gd->flags |= GENHD_FL_REMOVABLE;
3264 gd->events |= DISK_EVENT_MEDIA_CHANGE;
3267 blk_pm_runtime_init(sdp->request_queue, dev);
3268 device_add_disk(dev, gd, NULL);
3269 if (sdkp->capacity)
3270 sd_dif_config_host(sdkp);
3272 sd_revalidate_disk(gd);
3274 if (sdkp->security) {
3275 sdkp->opal_dev = init_opal_dev(sdp, &sd_sec_submit);
3276 if (sdkp->opal_dev)
3277 sd_printk(KERN_NOTICE, sdkp, "supports TCG Opal\n");
3280 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
3281 sdp->removable ? "removable " : "");
3282 scsi_autopm_put_device(sdp);
3283 put_device(&sdkp->dev);
3287 * sd_probe - called during driver initialization and whenever a
3288 * new scsi device is attached to the system. It is called once
3289 * for each scsi device (not just disks) present.
3290 * @dev: pointer to device object
3292 * Returns 0 if successful (or not interested in this scsi device
3293 * (e.g. scanner)); 1 when there is an error.
3295 * Note: this function is invoked from the scsi mid-level.
3296 * This function sets up the mapping between a given
3297 * <host,channel,id,lun> (found in sdp) and new device name
3298 * (e.g. /dev/sda). More precisely it is the block device major
3299 * and minor number that is chosen here.
3301 * Assume sd_probe is not re-entrant (for time being)
3302 * Also think about sd_probe() and sd_remove() running coincidentally.
3304 static int sd_probe(struct device *dev)
3306 struct scsi_device *sdp = to_scsi_device(dev);
3307 struct scsi_disk *sdkp;
3308 struct gendisk *gd;
3309 int index;
3310 int error;
3312 scsi_autopm_get_device(sdp);
3313 error = -ENODEV;
3314 if (sdp->type != TYPE_DISK &&
3315 sdp->type != TYPE_ZBC &&
3316 sdp->type != TYPE_MOD &&
3317 sdp->type != TYPE_RBC)
3318 goto out;
3320 #ifndef CONFIG_BLK_DEV_ZONED
3321 if (sdp->type == TYPE_ZBC)
3322 goto out;
3323 #endif
3324 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
3325 "sd_probe\n"));
3327 error = -ENOMEM;
3328 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
3329 if (!sdkp)
3330 goto out;
3332 gd = alloc_disk(SD_MINORS);
3333 if (!gd)
3334 goto out_free;
3336 index = ida_alloc(&sd_index_ida, GFP_KERNEL);
3337 if (index < 0) {
3338 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
3339 goto out_put;
3342 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
3343 if (error) {
3344 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
3345 goto out_free_index;
3348 sdkp->device = sdp;
3349 sdkp->driver = &sd_template;
3350 sdkp->disk = gd;
3351 sdkp->index = index;
3352 atomic_set(&sdkp->openers, 0);
3353 atomic_set(&sdkp->device->ioerr_cnt, 0);
3355 if (!sdp->request_queue->rq_timeout) {
3356 if (sdp->type != TYPE_MOD)
3357 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
3358 else
3359 blk_queue_rq_timeout(sdp->request_queue,
3360 SD_MOD_TIMEOUT);
3363 device_initialize(&sdkp->dev);
3364 sdkp->dev.parent = dev;
3365 sdkp->dev.class = &sd_disk_class;
3366 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
3368 error = device_add(&sdkp->dev);
3369 if (error)
3370 goto out_free_index;
3372 get_device(dev);
3373 dev_set_drvdata(dev, sdkp);
3375 get_device(&sdkp->dev); /* prevent release before async_schedule */
3376 async_schedule_domain(sd_probe_async, sdkp, &scsi_sd_probe_domain);
3378 return 0;
3380 out_free_index:
3381 ida_free(&sd_index_ida, index);
3382 out_put:
3383 put_disk(gd);
3384 out_free:
3385 kfree(sdkp);
3386 out:
3387 scsi_autopm_put_device(sdp);
3388 return error;
3392 * sd_remove - called whenever a scsi disk (previously recognized by
3393 * sd_probe) is detached from the system. It is called (potentially
3394 * multiple times) during sd module unload.
3395 * @dev: pointer to device object
3397 * Note: this function is invoked from the scsi mid-level.
3398 * This function potentially frees up a device name (e.g. /dev/sdc)
3399 * that could be re-used by a subsequent sd_probe().
3400 * This function is not called when the built-in sd driver is "exit-ed".
3402 static int sd_remove(struct device *dev)
3404 struct scsi_disk *sdkp;
3405 dev_t devt;
3407 sdkp = dev_get_drvdata(dev);
3408 devt = disk_devt(sdkp->disk);
3409 scsi_autopm_get_device(sdkp->device);
3411 async_synchronize_full_domain(&scsi_sd_pm_domain);
3412 async_synchronize_full_domain(&scsi_sd_probe_domain);
3413 device_del(&sdkp->dev);
3414 del_gendisk(sdkp->disk);
3415 sd_shutdown(dev);
3417 free_opal_dev(sdkp->opal_dev);
3419 blk_register_region(devt, SD_MINORS, NULL,
3420 sd_default_probe, NULL, NULL);
3422 mutex_lock(&sd_ref_mutex);
3423 dev_set_drvdata(dev, NULL);
3424 put_device(&sdkp->dev);
3425 mutex_unlock(&sd_ref_mutex);
3427 return 0;
3431 * scsi_disk_release - Called to free the scsi_disk structure
3432 * @dev: pointer to embedded class device
3434 * sd_ref_mutex must be held entering this routine. Because it is
3435 * called on last put, you should always use the scsi_disk_get()
3436 * scsi_disk_put() helpers which manipulate the semaphore directly
3437 * and never do a direct put_device.
3439 static void scsi_disk_release(struct device *dev)
3441 struct scsi_disk *sdkp = to_scsi_disk(dev);
3442 struct gendisk *disk = sdkp->disk;
3444 ida_free(&sd_index_ida, sdkp->index);
3446 disk->private_data = NULL;
3447 put_disk(disk);
3448 put_device(&sdkp->device->sdev_gendev);
3450 kfree(sdkp);
3453 static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
3455 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3456 struct scsi_sense_hdr sshdr;
3457 struct scsi_device *sdp = sdkp->device;
3458 int res;
3460 if (start)
3461 cmd[4] |= 1; /* START */
3463 if (sdp->start_stop_pwr_cond)
3464 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3466 if (!scsi_device_online(sdp))
3467 return -ENODEV;
3469 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, &sshdr,
3470 SD_TIMEOUT, SD_MAX_RETRIES, 0, RQF_PM, NULL);
3471 if (res) {
3472 sd_print_result(sdkp, "Start/Stop Unit failed", res);
3473 if (driver_byte(res) == DRIVER_SENSE)
3474 sd_print_sense_hdr(sdkp, &sshdr);
3475 if (scsi_sense_valid(&sshdr) &&
3476 /* 0x3a is medium not present */
3477 sshdr.asc == 0x3a)
3478 res = 0;
3481 /* SCSI error codes must not go to the generic layer */
3482 if (res)
3483 return -EIO;
3485 return 0;
3489 * Send a SYNCHRONIZE CACHE instruction down to the device through
3490 * the normal SCSI command structure. Wait for the command to
3491 * complete.
3493 static void sd_shutdown(struct device *dev)
3495 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3497 if (!sdkp)
3498 return; /* this can happen */
3500 if (pm_runtime_suspended(dev))
3501 return;
3503 if (sdkp->WCE && sdkp->media_present) {
3504 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3505 sd_sync_cache(sdkp, NULL);
3508 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3509 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3510 sd_start_stop_device(sdkp, 0);
3514 static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
3516 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3517 struct scsi_sense_hdr sshdr;
3518 int ret = 0;
3520 if (!sdkp) /* E.g.: runtime suspend following sd_remove() */
3521 return 0;
3523 if (sdkp->WCE && sdkp->media_present) {
3524 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3525 ret = sd_sync_cache(sdkp, &sshdr);
3527 if (ret) {
3528 /* ignore OFFLINE device */
3529 if (ret == -ENODEV)
3530 return 0;
3532 if (!scsi_sense_valid(&sshdr) ||
3533 sshdr.sense_key != ILLEGAL_REQUEST)
3534 return ret;
3537 * sshdr.sense_key == ILLEGAL_REQUEST means this drive
3538 * doesn't support sync. There's not much to do and
3539 * suspend shouldn't fail.
3541 ret = 0;
3545 if (sdkp->device->manage_start_stop) {
3546 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3547 /* an error is not worth aborting a system sleep */
3548 ret = sd_start_stop_device(sdkp, 0);
3549 if (ignore_stop_errors)
3550 ret = 0;
3553 return ret;
3556 static int sd_suspend_system(struct device *dev)
3558 return sd_suspend_common(dev, true);
3561 static int sd_suspend_runtime(struct device *dev)
3563 return sd_suspend_common(dev, false);
3566 static int sd_resume(struct device *dev)
3568 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3569 int ret;
3571 if (!sdkp) /* E.g.: runtime resume at the start of sd_probe() */
3572 return 0;
3574 if (!sdkp->device->manage_start_stop)
3575 return 0;
3577 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
3578 ret = sd_start_stop_device(sdkp, 1);
3579 if (!ret)
3580 opal_unlock_from_suspend(sdkp->opal_dev);
3581 return ret;
3585 * init_sd - entry point for this driver (both when built in or when
3586 * a module).
3588 * Note: this function registers this driver with the scsi mid-level.
3590 static int __init init_sd(void)
3592 int majors = 0, i, err;
3594 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3596 for (i = 0; i < SD_MAJORS; i++) {
3597 if (register_blkdev(sd_major(i), "sd") != 0)
3598 continue;
3599 majors++;
3600 blk_register_region(sd_major(i), SD_MINORS, NULL,
3601 sd_default_probe, NULL, NULL);
3604 if (!majors)
3605 return -ENODEV;
3607 err = class_register(&sd_disk_class);
3608 if (err)
3609 goto err_out;
3611 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3612 0, 0, NULL);
3613 if (!sd_cdb_cache) {
3614 printk(KERN_ERR "sd: can't init extended cdb cache\n");
3615 err = -ENOMEM;
3616 goto err_out_class;
3619 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3620 if (!sd_cdb_pool) {
3621 printk(KERN_ERR "sd: can't init extended cdb pool\n");
3622 err = -ENOMEM;
3623 goto err_out_cache;
3626 err = scsi_register_driver(&sd_template.gendrv);
3627 if (err)
3628 goto err_out_driver;
3630 return 0;
3632 err_out_driver:
3633 mempool_destroy(sd_cdb_pool);
3635 err_out_cache:
3636 kmem_cache_destroy(sd_cdb_cache);
3638 err_out_class:
3639 class_unregister(&sd_disk_class);
3640 err_out:
3641 for (i = 0; i < SD_MAJORS; i++)
3642 unregister_blkdev(sd_major(i), "sd");
3643 return err;
3647 * exit_sd - exit point for this driver (when it is a module).
3649 * Note: this function unregisters this driver from the scsi mid-level.
3651 static void __exit exit_sd(void)
3653 int i;
3655 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3657 scsi_unregister_driver(&sd_template.gendrv);
3658 mempool_destroy(sd_cdb_pool);
3659 kmem_cache_destroy(sd_cdb_cache);
3661 class_unregister(&sd_disk_class);
3663 for (i = 0; i < SD_MAJORS; i++) {
3664 blk_unregister_region(sd_major(i), SD_MINORS);
3665 unregister_blkdev(sd_major(i), "sd");
3669 module_init(init_sd);
3670 module_exit(exit_sd);
3672 static void sd_print_sense_hdr(struct scsi_disk *sdkp,
3673 struct scsi_sense_hdr *sshdr)
3675 scsi_print_sense_hdr(sdkp->device,
3676 sdkp->disk ? sdkp->disk->disk_name : NULL, sshdr);
3679 static void sd_print_result(const struct scsi_disk *sdkp, const char *msg,
3680 int result)
3682 const char *hb_string = scsi_hostbyte_string(result);
3683 const char *db_string = scsi_driverbyte_string(result);
3685 if (hb_string || db_string)
3686 sd_printk(KERN_INFO, sdkp,
3687 "%s: Result: hostbyte=%s driverbyte=%s\n", msg,
3688 hb_string ? hb_string : "invalid",
3689 db_string ? db_string : "invalid");
3690 else
3691 sd_printk(KERN_INFO, sdkp,
3692 "%s: Result: hostbyte=0x%02x driverbyte=0x%02x\n",
3693 msg, host_byte(result), driver_byte(result));