blob: 326e2877f1698fadc1ebdb58358feb05a5e73e40 [file] [log] [blame]
Thomas Gleixner09c434b2019-05-19 13:08:20 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * sd.c Copyright (C) 1992 Drew Eckhardt
4 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
5 *
6 * Linux scsi disk driver
7 * Initial versions: Drew Eckhardt
8 * Subsequent revisions: Eric Youngdale
9 * Modification history:
10 * - Drew Eckhardt <drew@colorado.edu> original
11 * - Eric Youngdale <eric@andante.org> add scatter-gather, multiple
12 * outstanding request, and other enhancements.
13 * Support loadable low-level scsi drivers.
14 * - Jirka Hanika <geo@ff.cuni.cz> support more scsi disks using
15 * eight major numbers.
16 * - Richard Gooch <rgooch@atnf.csiro.au> support devfs.
17 * - Torben Mathiasen <tmm@image.dk> Resource allocation fixes in
18 * sd_init and cleanups.
19 * - Alex Davis <letmein@erols.com> Fix problem where partition info
20 * not being read in sd_open. Fix problem where removable media
21 * could be ejected after sd_open.
22 * - Douglas Gilbert <dgilbert@interlog.com> cleanup for lk 2.5.x
23 * - Badari Pulavarty <pbadari@us.ibm.com>, Matthew Wilcox
24 * <willy@debian.org>, Kurt Garloff <garloff@suse.de>:
25 * Support 32k/1M disks.
26 *
27 * Logging policy (needs CONFIG_SCSI_LOGGING defined):
28 * - setting up transfer: SCSI_LOG_HLQUEUE levels 1 and 2
29 * - end of transfer (bh + scsi_lib): SCSI_LOG_HLCOMPLETE level 1
30 * - entering sd_ioctl: SCSI_LOG_IOCTL level 1
31 * - entering other commands: SCSI_LOG_HLQUEUE level 3
32 * Note: when the logging level is set by the user, it must be greater
33 * than the level indicated above to trigger output.
34 */
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/module.h>
37#include <linux/fs.h>
38#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/mm.h>
40#include <linux/bio.h>
41#include <linux/genhd.h>
42#include <linux/hdreg.h>
43#include <linux/errno.h>
44#include <linux/idr.h>
45#include <linux/interrupt.h>
46#include <linux/init.h>
47#include <linux/blkdev.h>
48#include <linux/blkpg.h>
Bart Van Asschebca6b062018-09-26 14:01:03 -070049#include <linux/blk-pm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include <linux/delay.h>
Arjan van de Ven0b950672006-01-11 13:16:10 +010051#include <linux/mutex.h>
James Bottomley7404ad3b2008-08-31 10:41:52 -050052#include <linux/string_helpers.h>
Arjan van de Ven4ace92f2009-01-04 05:32:28 -080053#include <linux/async.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090054#include <linux/slab.h>
Christoph Hellwigd80210f2017-06-19 14:26:46 +020055#include <linux/sed-opal.h>
Lin Ming54f575882011-12-05 09:20:26 +080056#include <linux/pm_runtime.h>
Christoph Hellwig924d55b2015-10-15 14:10:49 +020057#include <linux/pr.h>
Christoph Hellwig8475c812016-09-11 19:35:41 +020058#include <linux/t10-pi.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080059#include <linux/uaccess.h>
Dave Hansen8f76d152009-04-21 16:43:27 -070060#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62#include <scsi/scsi.h>
63#include <scsi/scsi_cmnd.h>
64#include <scsi/scsi_dbg.h>
65#include <scsi/scsi_device.h>
66#include <scsi/scsi_driver.h>
67#include <scsi/scsi_eh.h>
68#include <scsi/scsi_host.h>
69#include <scsi/scsi_ioctl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#include <scsi/scsicam.h>
71
Martin K. Petersenaa916962008-06-17 12:47:32 -040072#include "sd.h"
Dan Williamsa7a20d12012-03-22 17:05:11 -070073#include "scsi_priv.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070074#include "scsi_logging.h"
75
Rene Hermanf018fa52006-03-08 00:14:20 -080076MODULE_AUTHOR("Eric Youngdale");
77MODULE_DESCRIPTION("SCSI disk (sd) driver");
78MODULE_LICENSE("GPL");
79
80MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
81MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
82MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
83MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
84MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
85MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
86MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
87MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
88MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
89MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
90MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
91MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
92MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
93MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
94MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
95MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +040096MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
97MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
98MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
Hannes Reinecke89d94752016-10-18 15:40:34 +090099MODULE_ALIAS_SCSI_DEVICE(TYPE_ZBC);
Rene Hermanf018fa52006-03-08 00:14:20 -0800100
Tejun Heo870d6652008-08-25 19:47:25 +0900101#if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
Tejun Heof615b482008-08-25 19:47:24 +0900102#define SD_MINORS 16
Tejun Heo870d6652008-08-25 19:47:25 +0900103#else
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900104#define SD_MINORS 0
Tejun Heo870d6652008-08-25 19:47:25 +0900105#endif
106
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500107static void sd_config_discard(struct scsi_disk *, unsigned int);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400108static void sd_config_write_same(struct scsi_disk *);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800109static int sd_revalidate_disk(struct gendisk *);
Tejun Heo72ec24b2010-05-15 20:09:32 +0200110static void sd_unlock_native_capacity(struct gendisk *disk);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800111static int sd_probe(struct device *);
112static int sd_remove(struct device *);
113static void sd_shutdown(struct device *);
Oliver Neukum95897912013-09-16 13:28:15 +0200114static int sd_suspend_system(struct device *);
115static int sd_suspend_runtime(struct device *);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800116static int sd_resume(struct device *);
117static void sd_rescan(struct device *);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100118static blk_status_t sd_init_command(struct scsi_cmnd *SCpnt);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +0200119static void sd_uninit_command(struct scsi_cmnd *SCpnt);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800120static int sd_done(struct scsi_cmnd *);
Hannes Reinecke7a38dc02017-04-06 15:36:29 +0200121static void sd_eh_reset(struct scsi_cmnd *);
James Bottomley24510792013-11-11 13:44:53 +0100122static int sd_eh_action(struct scsi_cmnd *, int);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800123static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
Tony Jonesee959b02008-02-22 00:13:36 +0100124static void scsi_disk_release(struct device *cdev);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800125static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
Hannes Reineckeef613292014-10-24 14:27:00 +0200126static void sd_print_result(const struct scsi_disk *, const char *, int);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800127
Tejun Heof27bac22008-07-14 14:59:30 +0900128static DEFINE_IDA(sd_index_ida);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130/* This semaphore is used to mediate the 0->1 reference get in the
131 * face of object destruction (i.e. we can't allow a get on an
132 * object after last put) */
Arjan van de Ven0b950672006-01-11 13:16:10 +0100133static DEFINE_MUTEX(sd_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
H Hartley Sweeten439d77f2010-08-10 18:01:20 -0700135static struct kmem_cache *sd_cdb_cache;
136static mempool_t *sd_cdb_pool;
Jens Axboe61cce6f2018-12-12 06:46:55 -0700137static mempool_t *sd_page_pool;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -0400138
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600139static const char *sd_cache_types[] = {
140 "write through", "none", "write back",
141 "write back, no read (daft)"
142};
143
Vaughan Caocb2fb682014-06-03 17:37:30 +0800144static void sd_set_flush_flag(struct scsi_disk *sdkp)
145{
Jens Axboeeb310e22016-03-30 10:06:11 -0600146 bool wc = false, fua = false;
Vaughan Caocb2fb682014-06-03 17:37:30 +0800147
148 if (sdkp->WCE) {
Jens Axboeeb310e22016-03-30 10:06:11 -0600149 wc = true;
Vaughan Caocb2fb682014-06-03 17:37:30 +0800150 if (sdkp->DPOFUA)
Jens Axboeeb310e22016-03-30 10:06:11 -0600151 fua = true;
Vaughan Caocb2fb682014-06-03 17:37:30 +0800152 }
153
Jens Axboeeb310e22016-03-30 10:06:11 -0600154 blk_queue_write_cache(sdkp->disk->queue, wc, fua);
Vaughan Caocb2fb682014-06-03 17:37:30 +0800155}
156
Tony Jonesee959b02008-02-22 00:13:36 +0100157static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700158cache_type_store(struct device *dev, struct device_attribute *attr,
159 const char *buf, size_t count)
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600160{
Martin K. Petersen4c117122017-05-25 09:34:30 -0400161 int ct, rcd, wce, sp;
Tony Jonesee959b02008-02-22 00:13:36 +0100162 struct scsi_disk *sdkp = to_scsi_disk(dev);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600163 struct scsi_device *sdp = sdkp->device;
164 char buffer[64];
165 char *buffer_data;
166 struct scsi_mode_data data;
167 struct scsi_sense_hdr sshdr;
Ben Hutchings2ee3e262013-05-27 19:07:19 +0100168 static const char temp[] = "temporary ";
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600169 int len;
170
Hannes Reinecke89d94752016-10-18 15:40:34 +0900171 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600172 /* no cache control on RBC devices; theoretically they
173 * can do it, but there's probably so many exceptions
174 * it's not worth the risk */
175 return -EINVAL;
176
James Bottomley39c60a02013-04-24 14:02:53 -0700177 if (strncmp(buf, temp, sizeof(temp) - 1) == 0) {
178 buf += sizeof(temp) - 1;
179 sdkp->cache_override = 1;
180 } else {
181 sdkp->cache_override = 0;
182 }
183
Martin K. Petersen4c117122017-05-25 09:34:30 -0400184 ct = sysfs_match_string(sd_cache_types, buf);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600185 if (ct < 0)
186 return -EINVAL;
Martin K. Petersen4c117122017-05-25 09:34:30 -0400187
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600188 rcd = ct & 0x01 ? 1 : 0;
Sujit Reddy Thumma2eefd572014-08-11 15:40:37 +0300189 wce = (ct & 0x02) && !sdkp->write_prot ? 1 : 0;
James Bottomley39c60a02013-04-24 14:02:53 -0700190
191 if (sdkp->cache_override) {
192 sdkp->WCE = wce;
193 sdkp->RCD = rcd;
Vaughan Caocb2fb682014-06-03 17:37:30 +0800194 sd_set_flush_flag(sdkp);
James Bottomley39c60a02013-04-24 14:02:53 -0700195 return count;
196 }
197
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600198 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
199 SD_MAX_RETRIES, &data, NULL))
200 return -EINVAL;
Andrew Mortona9312fb2006-03-25 03:08:30 -0800201 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600202 data.block_descriptor_length);
203 buffer_data = buffer + data.header_length +
204 data.block_descriptor_length;
205 buffer_data[2] &= ~0x05;
206 buffer_data[2] |= wce << 2 | rcd;
207 sp = buffer_data[0] & 0x80 ? 1 : 0;
Gabriel Krisman Bertazi2c5d16d2015-10-30 16:04:43 -0200208 buffer_data[0] &= ~0x80;
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600209
Ivan Mironov44759972018-12-23 12:41:58 +0500210 /*
211 * Ensure WP, DPOFUA, and RESERVED fields are cleared in
212 * received mode parameter buffer before doing MODE SELECT.
213 */
214 data.device_specific = 0;
215
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600216 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
217 SD_MAX_RETRIES, &data, &sshdr)) {
218 if (scsi_sense_valid(&sshdr))
Martin K. Petersene73aec82007-02-27 22:40:55 -0500219 sd_print_sense_hdr(sdkp, &sshdr);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600220 return -EINVAL;
221 }
Andrew Pattersonf98a8ca2008-09-04 14:27:35 -0600222 revalidate_disk(sdkp->disk);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600223 return count;
224}
225
Tony Jonesee959b02008-02-22 00:13:36 +0100226static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700227manage_start_stop_show(struct device *dev, struct device_attribute *attr,
228 char *buf)
229{
230 struct scsi_disk *sdkp = to_scsi_disk(dev);
231 struct scsi_device *sdp = sdkp->device;
232
Martin K. Petersen4c117122017-05-25 09:34:30 -0400233 return sprintf(buf, "%u\n", sdp->manage_start_stop);
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700234}
235
236static ssize_t
237manage_start_stop_store(struct device *dev, struct device_attribute *attr,
238 const char *buf, size_t count)
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900239{
Tony Jonesee959b02008-02-22 00:13:36 +0100240 struct scsi_disk *sdkp = to_scsi_disk(dev);
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900241 struct scsi_device *sdp = sdkp->device;
weiping zhang623401e2017-10-12 14:57:06 +0800242 bool v;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900243
244 if (!capable(CAP_SYS_ADMIN))
245 return -EACCES;
246
weiping zhang623401e2017-10-12 14:57:06 +0800247 if (kstrtobool(buf, &v))
248 return -EINVAL;
249
250 sdp->manage_start_stop = v;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900251
252 return count;
253}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700254static DEVICE_ATTR_RW(manage_start_stop);
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900255
Tony Jonesee959b02008-02-22 00:13:36 +0100256static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700257allow_restart_show(struct device *dev, struct device_attribute *attr, char *buf)
258{
259 struct scsi_disk *sdkp = to_scsi_disk(dev);
260
Martin K. Petersen4c117122017-05-25 09:34:30 -0400261 return sprintf(buf, "%u\n", sdkp->device->allow_restart);
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700262}
263
264static ssize_t
265allow_restart_store(struct device *dev, struct device_attribute *attr,
266 const char *buf, size_t count)
Brian Kinga144c5a2006-06-27 11:10:31 -0500267{
weiping zhang658e9a62017-10-12 14:56:44 +0800268 bool v;
Tony Jonesee959b02008-02-22 00:13:36 +0100269 struct scsi_disk *sdkp = to_scsi_disk(dev);
Brian Kinga144c5a2006-06-27 11:10:31 -0500270 struct scsi_device *sdp = sdkp->device;
271
272 if (!capable(CAP_SYS_ADMIN))
273 return -EACCES;
274
Hannes Reinecke89d94752016-10-18 15:40:34 +0900275 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
Brian Kinga144c5a2006-06-27 11:10:31 -0500276 return -EINVAL;
277
weiping zhang658e9a62017-10-12 14:56:44 +0800278 if (kstrtobool(buf, &v))
279 return -EINVAL;
280
281 sdp->allow_restart = v;
Brian Kinga144c5a2006-06-27 11:10:31 -0500282
283 return count;
284}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700285static DEVICE_ATTR_RW(allow_restart);
Brian Kinga144c5a2006-06-27 11:10:31 -0500286
Tony Jonesee959b02008-02-22 00:13:36 +0100287static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700288cache_type_show(struct device *dev, struct device_attribute *attr, char *buf)
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600289{
Tony Jonesee959b02008-02-22 00:13:36 +0100290 struct scsi_disk *sdkp = to_scsi_disk(dev);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600291 int ct = sdkp->RCD + 2*sdkp->WCE;
292
Martin K. Petersen4c117122017-05-25 09:34:30 -0400293 return sprintf(buf, "%s\n", sd_cache_types[ct]);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600294}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700295static DEVICE_ATTR_RW(cache_type);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600296
Tony Jonesee959b02008-02-22 00:13:36 +0100297static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700298FUA_show(struct device *dev, struct device_attribute *attr, char *buf)
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600299{
Tony Jonesee959b02008-02-22 00:13:36 +0100300 struct scsi_disk *sdkp = to_scsi_disk(dev);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600301
Martin K. Petersen4c117122017-05-25 09:34:30 -0400302 return sprintf(buf, "%u\n", sdkp->DPOFUA);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600303}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700304static DEVICE_ATTR_RO(FUA);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600305
Tony Jonesee959b02008-02-22 00:13:36 +0100306static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700307protection_type_show(struct device *dev, struct device_attribute *attr,
308 char *buf)
Martin K. Petersene0597d72008-07-17 04:28:34 -0400309{
310 struct scsi_disk *sdkp = to_scsi_disk(dev);
311
Martin K. Petersen4c117122017-05-25 09:34:30 -0400312 return sprintf(buf, "%u\n", sdkp->protection_type);
Martin K. Petersene0597d72008-07-17 04:28:34 -0400313}
314
315static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700316protection_type_store(struct device *dev, struct device_attribute *attr,
317 const char *buf, size_t count)
Martin K. Petersen81724992012-08-28 14:29:34 -0400318{
319 struct scsi_disk *sdkp = to_scsi_disk(dev);
320 unsigned int val;
321 int err;
322
323 if (!capable(CAP_SYS_ADMIN))
324 return -EACCES;
325
326 err = kstrtouint(buf, 10, &val);
327
328 if (err)
329 return err;
330
Bart Van Assche830cc352017-08-25 13:46:35 -0700331 if (val <= T10_PI_TYPE3_PROTECTION)
Martin K. Petersen81724992012-08-28 14:29:34 -0400332 sdkp->protection_type = val;
333
334 return count;
335}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700336static DEVICE_ATTR_RW(protection_type);
Martin K. Petersen81724992012-08-28 14:29:34 -0400337
338static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700339protection_mode_show(struct device *dev, struct device_attribute *attr,
340 char *buf)
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400341{
342 struct scsi_disk *sdkp = to_scsi_disk(dev);
343 struct scsi_device *sdp = sdkp->device;
344 unsigned int dif, dix;
345
346 dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
347 dix = scsi_host_dix_capable(sdp->host, sdkp->protection_type);
348
Christoph Hellwig8475c812016-09-11 19:35:41 +0200349 if (!dix && scsi_host_dix_capable(sdp->host, T10_PI_TYPE0_PROTECTION)) {
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400350 dif = 0;
351 dix = 1;
352 }
353
354 if (!dif && !dix)
Martin K. Petersen4c117122017-05-25 09:34:30 -0400355 return sprintf(buf, "none\n");
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400356
Martin K. Petersen4c117122017-05-25 09:34:30 -0400357 return sprintf(buf, "%s%u\n", dix ? "dix" : "dif", dif);
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400358}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700359static DEVICE_ATTR_RO(protection_mode);
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400360
361static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700362app_tag_own_show(struct device *dev, struct device_attribute *attr, char *buf)
Martin K. Petersene0597d72008-07-17 04:28:34 -0400363{
364 struct scsi_disk *sdkp = to_scsi_disk(dev);
365
Martin K. Petersen4c117122017-05-25 09:34:30 -0400366 return sprintf(buf, "%u\n", sdkp->ATO);
Martin K. Petersene0597d72008-07-17 04:28:34 -0400367}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700368static DEVICE_ATTR_RO(app_tag_own);
Martin K. Petersene0597d72008-07-17 04:28:34 -0400369
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500370static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700371thin_provisioning_show(struct device *dev, struct device_attribute *attr,
372 char *buf)
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500373{
374 struct scsi_disk *sdkp = to_scsi_disk(dev);
375
Martin K. Petersen4c117122017-05-25 09:34:30 -0400376 return sprintf(buf, "%u\n", sdkp->lbpme);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500377}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700378static DEVICE_ATTR_RO(thin_provisioning);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500379
Martin K. Petersen4c117122017-05-25 09:34:30 -0400380/* sysfs_match_string() requires dense arrays */
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500381static const char *lbp_mode[] = {
382 [SD_LBP_FULL] = "full",
383 [SD_LBP_UNMAP] = "unmap",
384 [SD_LBP_WS16] = "writesame_16",
385 [SD_LBP_WS10] = "writesame_10",
386 [SD_LBP_ZERO] = "writesame_zero",
387 [SD_LBP_DISABLE] = "disabled",
388};
389
390static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700391provisioning_mode_show(struct device *dev, struct device_attribute *attr,
392 char *buf)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500393{
394 struct scsi_disk *sdkp = to_scsi_disk(dev);
395
Martin K. Petersen4c117122017-05-25 09:34:30 -0400396 return sprintf(buf, "%s\n", lbp_mode[sdkp->provisioning_mode]);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500397}
398
399static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700400provisioning_mode_store(struct device *dev, struct device_attribute *attr,
401 const char *buf, size_t count)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500402{
403 struct scsi_disk *sdkp = to_scsi_disk(dev);
404 struct scsi_device *sdp = sdkp->device;
Martin K. Petersen4c117122017-05-25 09:34:30 -0400405 int mode;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500406
407 if (!capable(CAP_SYS_ADMIN))
408 return -EACCES;
409
Hannes Reinecke89d94752016-10-18 15:40:34 +0900410 if (sd_is_zoned(sdkp)) {
411 sd_config_discard(sdkp, SD_LBP_DISABLE);
412 return count;
413 }
414
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500415 if (sdp->type != TYPE_DISK)
416 return -EINVAL;
417
Martin K. Petersen4c117122017-05-25 09:34:30 -0400418 mode = sysfs_match_string(lbp_mode, buf);
419 if (mode < 0)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500420 return -EINVAL;
421
Martin K. Petersen4c117122017-05-25 09:34:30 -0400422 sd_config_discard(sdkp, mode);
423
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500424 return count;
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500425}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700426static DEVICE_ATTR_RW(provisioning_mode);
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500427
Martin K. Petersen4c117122017-05-25 09:34:30 -0400428/* sysfs_match_string() requires dense arrays */
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200429static const char *zeroing_mode[] = {
430 [SD_ZERO_WRITE] = "write",
431 [SD_ZERO_WS] = "writesame",
432 [SD_ZERO_WS16_UNMAP] = "writesame_16_unmap",
433 [SD_ZERO_WS10_UNMAP] = "writesame_10_unmap",
434};
435
436static ssize_t
437zeroing_mode_show(struct device *dev, struct device_attribute *attr,
438 char *buf)
439{
440 struct scsi_disk *sdkp = to_scsi_disk(dev);
441
Martin K. Petersen4c117122017-05-25 09:34:30 -0400442 return sprintf(buf, "%s\n", zeroing_mode[sdkp->zeroing_mode]);
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200443}
444
445static ssize_t
446zeroing_mode_store(struct device *dev, struct device_attribute *attr,
447 const char *buf, size_t count)
448{
449 struct scsi_disk *sdkp = to_scsi_disk(dev);
Martin K. Petersen4c117122017-05-25 09:34:30 -0400450 int mode;
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200451
452 if (!capable(CAP_SYS_ADMIN))
453 return -EACCES;
454
Martin K. Petersen4c117122017-05-25 09:34:30 -0400455 mode = sysfs_match_string(zeroing_mode, buf);
456 if (mode < 0)
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200457 return -EINVAL;
458
Martin K. Petersen4c117122017-05-25 09:34:30 -0400459 sdkp->zeroing_mode = mode;
460
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200461 return count;
462}
463static DEVICE_ATTR_RW(zeroing_mode);
464
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500465static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700466max_medium_access_timeouts_show(struct device *dev,
467 struct device_attribute *attr, char *buf)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500468{
469 struct scsi_disk *sdkp = to_scsi_disk(dev);
470
Martin K. Petersen4c117122017-05-25 09:34:30 -0400471 return sprintf(buf, "%u\n", sdkp->max_medium_access_timeouts);
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500472}
473
474static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700475max_medium_access_timeouts_store(struct device *dev,
476 struct device_attribute *attr, const char *buf,
477 size_t count)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500478{
479 struct scsi_disk *sdkp = to_scsi_disk(dev);
480 int err;
481
482 if (!capable(CAP_SYS_ADMIN))
483 return -EACCES;
484
485 err = kstrtouint(buf, 10, &sdkp->max_medium_access_timeouts);
486
487 return err ? err : count;
488}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700489static DEVICE_ATTR_RW(max_medium_access_timeouts);
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500490
Martin K. Petersen5db44862012-09-18 12:19:32 -0400491static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700492max_write_same_blocks_show(struct device *dev, struct device_attribute *attr,
493 char *buf)
Martin K. Petersen5db44862012-09-18 12:19:32 -0400494{
495 struct scsi_disk *sdkp = to_scsi_disk(dev);
496
Martin K. Petersen4c117122017-05-25 09:34:30 -0400497 return sprintf(buf, "%u\n", sdkp->max_ws_blocks);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400498}
499
500static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700501max_write_same_blocks_store(struct device *dev, struct device_attribute *attr,
502 const char *buf, size_t count)
Martin K. Petersen5db44862012-09-18 12:19:32 -0400503{
504 struct scsi_disk *sdkp = to_scsi_disk(dev);
505 struct scsi_device *sdp = sdkp->device;
506 unsigned long max;
507 int err;
508
509 if (!capable(CAP_SYS_ADMIN))
510 return -EACCES;
511
Hannes Reinecke89d94752016-10-18 15:40:34 +0900512 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
Martin K. Petersen5db44862012-09-18 12:19:32 -0400513 return -EINVAL;
514
515 err = kstrtoul(buf, 10, &max);
516
517 if (err)
518 return err;
519
520 if (max == 0)
521 sdp->no_write_same = 1;
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400522 else if (max <= SD_MAX_WS16_BLOCKS) {
523 sdp->no_write_same = 0;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400524 sdkp->max_ws_blocks = max;
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400525 }
Martin K. Petersen5db44862012-09-18 12:19:32 -0400526
527 sd_config_write_same(sdkp);
528
529 return count;
530}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700531static DEVICE_ATTR_RW(max_write_same_blocks);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400532
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700533static struct attribute *sd_disk_attrs[] = {
534 &dev_attr_cache_type.attr,
535 &dev_attr_FUA.attr,
536 &dev_attr_allow_restart.attr,
537 &dev_attr_manage_start_stop.attr,
538 &dev_attr_protection_type.attr,
539 &dev_attr_protection_mode.attr,
540 &dev_attr_app_tag_own.attr,
541 &dev_attr_thin_provisioning.attr,
542 &dev_attr_provisioning_mode.attr,
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200543 &dev_attr_zeroing_mode.attr,
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700544 &dev_attr_max_write_same_blocks.attr,
545 &dev_attr_max_medium_access_timeouts.attr,
546 NULL,
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600547};
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700548ATTRIBUTE_GROUPS(sd_disk);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600549
550static struct class sd_disk_class = {
551 .name = "scsi_disk",
552 .owner = THIS_MODULE,
Tony Jonesee959b02008-02-22 00:13:36 +0100553 .dev_release = scsi_disk_release,
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700554 .dev_groups = sd_disk_groups,
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600555};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Aaron Lu691e3d32012-11-09 15:27:55 +0800557static const struct dev_pm_ops sd_pm_ops = {
Oliver Neukum95897912013-09-16 13:28:15 +0200558 .suspend = sd_suspend_system,
Aaron Lu691e3d32012-11-09 15:27:55 +0800559 .resume = sd_resume,
Oliver Neukum95897912013-09-16 13:28:15 +0200560 .poweroff = sd_suspend_system,
Aaron Lu691e3d32012-11-09 15:27:55 +0800561 .restore = sd_resume,
Oliver Neukum95897912013-09-16 13:28:15 +0200562 .runtime_suspend = sd_suspend_runtime,
Aaron Lu691e3d32012-11-09 15:27:55 +0800563 .runtime_resume = sd_resume,
564};
565
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566static struct scsi_driver sd_template = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 .gendrv = {
568 .name = "sd",
Christoph Hellwig3af6b352014-11-12 18:34:51 +0100569 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 .probe = sd_probe,
Bart Van Asschef049cf12019-04-30 14:39:18 -0700571 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 .remove = sd_remove,
573 .shutdown = sd_shutdown,
Aaron Lu691e3d32012-11-09 15:27:55 +0800574 .pm = &sd_pm_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 },
576 .rescan = sd_rescan,
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +0200577 .init_command = sd_init_command,
578 .uninit_command = sd_uninit_command,
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800579 .done = sd_done,
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500580 .eh_action = sd_eh_action,
Hannes Reinecke7a38dc02017-04-06 15:36:29 +0200581 .eh_reset = sd_eh_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582};
583
584/*
Hannes Reinecke0761df92013-05-10 11:06:16 +0200585 * Dummy kobj_map->probe function.
586 * The default ->probe function will call modprobe, which is
587 * pointless as this module is already loaded.
588 */
589static struct kobject *sd_default_probe(dev_t devt, int *partno, void *data)
590{
591 return NULL;
592}
593
594/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 * Device no to disk mapping:
596 *
597 * major disc2 disc p1
598 * |............|.............|....|....| <- dev_t
599 * 31 20 19 8 7 4 3 0
600 *
601 * Inside a major, we have 16k disks, however mapped non-
602 * contiguously. The first 16 disks are for major0, the next
603 * ones with major1, ... Disk 256 is for major0 again, disk 272
604 * for major1, ...
605 * As we stay compatible with our numbering scheme, we can reuse
606 * the well-know SCSI majors 8, 65--71, 136--143.
607 */
608static int sd_major(int major_idx)
609{
610 switch (major_idx) {
611 case 0:
612 return SCSI_DISK0_MAJOR;
613 case 1 ... 7:
614 return SCSI_DISK1_MAJOR + major_idx - 1;
615 case 8 ... 15:
616 return SCSI_DISK8_MAJOR + major_idx - 8;
617 default:
618 BUG();
619 return 0; /* shut up gcc */
620 }
621}
622
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +0100623static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624{
625 struct scsi_disk *sdkp = NULL;
626
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +0100627 mutex_lock(&sd_ref_mutex);
628
Alan Stern39b7f1e2005-11-04 14:44:41 -0500629 if (disk->private_data) {
630 sdkp = scsi_disk(disk);
631 if (scsi_device_get(sdkp->device) == 0)
Tony Jonesee959b02008-02-22 00:13:36 +0100632 get_device(&sdkp->dev);
Alan Stern39b7f1e2005-11-04 14:44:41 -0500633 else
634 sdkp = NULL;
635 }
Arjan van de Ven0b950672006-01-11 13:16:10 +0100636 mutex_unlock(&sd_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 return sdkp;
638}
639
640static void scsi_disk_put(struct scsi_disk *sdkp)
641{
642 struct scsi_device *sdev = sdkp->device;
643
Arjan van de Ven0b950672006-01-11 13:16:10 +0100644 mutex_lock(&sd_ref_mutex);
Tony Jonesee959b02008-02-22 00:13:36 +0100645 put_device(&sdkp->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 scsi_device_put(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +0100647 mutex_unlock(&sd_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648}
649
Christoph Hellwigd80210f2017-06-19 14:26:46 +0200650#ifdef CONFIG_BLK_SED_OPAL
651static int sd_sec_submit(void *data, u16 spsp, u8 secp, void *buffer,
652 size_t len, bool send)
653{
654 struct scsi_device *sdev = data;
655 u8 cdb[12] = { 0, };
656 int ret;
657
658 cdb[0] = send ? SECURITY_PROTOCOL_OUT : SECURITY_PROTOCOL_IN;
659 cdb[1] = secp;
660 put_unaligned_be16(spsp, &cdb[2]);
661 put_unaligned_be32(len, &cdb[6]);
662
663 ret = scsi_execute_req(sdev, cdb,
664 send ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
665 buffer, len, NULL, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
666 return ret <= 0 ? ret : -EIO;
667}
668#endif /* CONFIG_BLK_SED_OPAL */
669
John Garry082c2cd2019-01-08 23:14:52 +0800670/*
671 * Look up the DIX operation based on whether the command is read or
672 * write and whether dix and dif are enabled.
673 */
674static unsigned int sd_prot_op(bool write, bool dix, bool dif)
675{
676 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
677 static const unsigned int ops[] = { /* wrt dix dif */
678 SCSI_PROT_NORMAL, /* 0 0 0 */
679 SCSI_PROT_READ_STRIP, /* 0 0 1 */
680 SCSI_PROT_READ_INSERT, /* 0 1 0 */
681 SCSI_PROT_READ_PASS, /* 0 1 1 */
682 SCSI_PROT_NORMAL, /* 1 0 0 */
683 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
684 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
685 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
686 };
687
688 return ops[write << 2 | dix << 1 | dif];
689}
690
691/*
692 * Returns a mask of the protection flags that are valid for a given DIX
693 * operation.
694 */
695static unsigned int sd_prot_flag_mask(unsigned int prot_op)
696{
697 static const unsigned int flag_mask[] = {
698 [SCSI_PROT_NORMAL] = 0,
699
700 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
701 SCSI_PROT_GUARD_CHECK |
702 SCSI_PROT_REF_CHECK |
703 SCSI_PROT_REF_INCREMENT,
704
705 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
706 SCSI_PROT_IP_CHECKSUM,
707
708 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
709 SCSI_PROT_GUARD_CHECK |
710 SCSI_PROT_REF_CHECK |
711 SCSI_PROT_REF_INCREMENT |
712 SCSI_PROT_IP_CHECKSUM,
713
714 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
715 SCSI_PROT_REF_INCREMENT,
716
717 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
718 SCSI_PROT_REF_CHECK |
719 SCSI_PROT_REF_INCREMENT |
720 SCSI_PROT_IP_CHECKSUM,
721
722 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
723 SCSI_PROT_GUARD_CHECK |
724 SCSI_PROT_REF_CHECK |
725 SCSI_PROT_REF_INCREMENT |
726 SCSI_PROT_IP_CHECKSUM,
727 };
728
729 return flag_mask[prot_op];
730}
731
Martin K. Petersenc6115292014-09-26 19:20:08 -0400732static unsigned char sd_setup_protect_cmnd(struct scsi_cmnd *scmd,
733 unsigned int dix, unsigned int dif)
734{
735 struct bio *bio = scmd->request->bio;
736 unsigned int prot_op = sd_prot_op(rq_data_dir(scmd->request), dix, dif);
737 unsigned int protect = 0;
738
739 if (dix) { /* DIX Type 0, 1, 2, 3 */
740 if (bio_integrity_flagged(bio, BIP_IP_CHECKSUM))
741 scmd->prot_flags |= SCSI_PROT_IP_CHECKSUM;
742
743 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
744 scmd->prot_flags |= SCSI_PROT_GUARD_CHECK;
745 }
746
Christoph Hellwig8475c812016-09-11 19:35:41 +0200747 if (dif != T10_PI_TYPE3_PROTECTION) { /* DIX/DIF Type 0, 1, 2 */
Martin K. Petersenc6115292014-09-26 19:20:08 -0400748 scmd->prot_flags |= SCSI_PROT_REF_INCREMENT;
749
750 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
751 scmd->prot_flags |= SCSI_PROT_REF_CHECK;
752 }
753
754 if (dif) { /* DIX/DIF Type 1, 2, 3 */
755 scmd->prot_flags |= SCSI_PROT_TRANSFER_PI;
756
757 if (bio_integrity_flagged(bio, BIP_DISK_NOCHECK))
758 protect = 3 << 5; /* Disable target PI checking */
759 else
760 protect = 1 << 5; /* Enable target PI checking */
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400761 }
762
763 scsi_set_prot_op(scmd, prot_op);
764 scsi_set_prot_type(scmd, dif);
Martin K. Petersenc6115292014-09-26 19:20:08 -0400765 scmd->prot_flags &= sd_prot_flag_mask(prot_op);
766
767 return protect;
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400768}
769
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500770static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
771{
772 struct request_queue *q = sdkp->disk->queue;
773 unsigned int logical_block_size = sdkp->device->sector_size;
774 unsigned int max_blocks = 0;
775
Martin K. Petersenbcd069b2017-04-05 19:21:25 +0200776 q->limits.discard_alignment =
777 sdkp->unmap_alignment * logical_block_size;
778 q->limits.discard_granularity =
779 max(sdkp->physical_block_size,
780 sdkp->unmap_granularity * logical_block_size);
Martin K. Petersen89730392012-02-13 15:39:00 -0500781 sdkp->provisioning_mode = mode;
782
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500783 switch (mode) {
784
Martin K. Petersen4c117122017-05-25 09:34:30 -0400785 case SD_LBP_FULL:
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500786 case SD_LBP_DISABLE:
Jens Axboe2bb4cd52015-07-14 08:15:12 -0600787 blk_queue_max_discard_sectors(q, 0);
Bart Van Assche8b904b52018-03-07 17:10:10 -0800788 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500789 return;
790
791 case SD_LBP_UNMAP:
Martin K. Petersen5db44862012-09-18 12:19:32 -0400792 max_blocks = min_not_zero(sdkp->max_unmap_blocks,
793 (u32)SD_MAX_WS16_BLOCKS);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500794 break;
795
796 case SD_LBP_WS16:
Martin K. Petersen28a0bc42017-09-27 21:35:12 -0400797 if (sdkp->device->unmap_limit_for_ws)
798 max_blocks = sdkp->max_unmap_blocks;
799 else
800 max_blocks = sdkp->max_ws_blocks;
801
802 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS16_BLOCKS);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500803 break;
804
805 case SD_LBP_WS10:
Martin K. Petersen28a0bc42017-09-27 21:35:12 -0400806 if (sdkp->device->unmap_limit_for_ws)
807 max_blocks = sdkp->max_unmap_blocks;
808 else
809 max_blocks = sdkp->max_ws_blocks;
810
811 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS10_BLOCKS);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500812 break;
813
814 case SD_LBP_ZERO:
Martin K. Petersen5db44862012-09-18 12:19:32 -0400815 max_blocks = min_not_zero(sdkp->max_ws_blocks,
816 (u32)SD_MAX_WS10_BLOCKS);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500817 break;
818 }
819
Jens Axboe2bb4cd52015-07-14 08:15:12 -0600820 blk_queue_max_discard_sectors(q, max_blocks * (logical_block_size >> 9));
Bart Van Assche8b904b52018-03-07 17:10:10 -0800821 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500822}
823
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100824static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500825{
Christoph Hellwig6a7b4392014-06-28 12:35:13 +0200826 struct scsi_device *sdp = cmd->device;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200827 struct request *rq = cmd->request;
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -0800828 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
829 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200830 unsigned int data_len = 24;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500831 char *buf;
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500832
Jens Axboe61cce6f2018-12-12 06:46:55 -0700833 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200834 if (!rq->special_vec.bv_page)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100835 return BLK_STS_RESOURCE;
Jens Axboe61cce6f2018-12-12 06:46:55 -0700836 clear_highpage(rq->special_vec.bv_page);
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700837 rq->special_vec.bv_offset = 0;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200838 rq->special_vec.bv_len = data_len;
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700839 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700840
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200841 cmd->cmd_len = 10;
842 cmd->cmnd[0] = UNMAP;
843 cmd->cmnd[8] = 24;
844
845 buf = page_address(rq->special_vec.bv_page);
846 put_unaligned_be16(6 + 16, &buf[0]);
847 put_unaligned_be16(16, &buf[2]);
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -0800848 put_unaligned_be64(lba, &buf[8]);
849 put_unaligned_be32(nr_blocks, &buf[16]);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200850
851 cmd->allowed = SD_MAX_RETRIES;
852 cmd->transfersize = data_len;
853 rq->timeout = SD_TIMEOUT;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200854
855 return scsi_init_io(cmd);
856}
857
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100858static blk_status_t sd_setup_write_same16_cmnd(struct scsi_cmnd *cmd,
859 bool unmap)
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200860{
861 struct scsi_device *sdp = cmd->device;
862 struct request *rq = cmd->request;
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -0800863 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
864 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200865 u32 data_len = sdp->sector_size;
866
Jens Axboe61cce6f2018-12-12 06:46:55 -0700867 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200868 if (!rq->special_vec.bv_page)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100869 return BLK_STS_RESOURCE;
Jens Axboe61cce6f2018-12-12 06:46:55 -0700870 clear_highpage(rq->special_vec.bv_page);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200871 rq->special_vec.bv_offset = 0;
872 rq->special_vec.bv_len = data_len;
873 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
874
875 cmd->cmd_len = 16;
876 cmd->cmnd[0] = WRITE_SAME_16;
Christoph Hellwig02d26102017-04-05 19:21:02 +0200877 if (unmap)
878 cmd->cmnd[1] = 0x8; /* UNMAP */
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -0800879 put_unaligned_be64(lba, &cmd->cmnd[2]);
880 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200881
882 cmd->allowed = SD_MAX_RETRIES;
883 cmd->transfersize = data_len;
Christoph Hellwig02d26102017-04-05 19:21:02 +0200884 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200885
886 return scsi_init_io(cmd);
887}
888
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100889static blk_status_t sd_setup_write_same10_cmnd(struct scsi_cmnd *cmd,
890 bool unmap)
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200891{
892 struct scsi_device *sdp = cmd->device;
893 struct request *rq = cmd->request;
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -0800894 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
895 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200896 u32 data_len = sdp->sector_size;
897
Jens Axboe61cce6f2018-12-12 06:46:55 -0700898 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200899 if (!rq->special_vec.bv_page)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100900 return BLK_STS_RESOURCE;
Jens Axboe61cce6f2018-12-12 06:46:55 -0700901 clear_highpage(rq->special_vec.bv_page);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200902 rq->special_vec.bv_offset = 0;
903 rq->special_vec.bv_len = data_len;
904 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
905
906 cmd->cmd_len = 10;
907 cmd->cmnd[0] = WRITE_SAME;
908 if (unmap)
909 cmd->cmnd[1] = 0x8; /* UNMAP */
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -0800910 put_unaligned_be32(lba, &cmd->cmnd[2]);
911 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200912
913 cmd->allowed = SD_MAX_RETRIES;
914 cmd->transfersize = data_len;
Christoph Hellwig02d26102017-04-05 19:21:02 +0200915 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200916
917 return scsi_init_io(cmd);
FUJITA Tomonorif1126e92010-07-01 19:49:18 +0900918}
919
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100920static blk_status_t sd_setup_write_zeroes_cmnd(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921{
922 struct request *rq = cmd->request;
923 struct scsi_device *sdp = cmd->device;
924 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -0800925 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
926 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Christoph Hellwige4b87832017-04-05 19:21:12 +0200928 if (!(rq->cmd_flags & REQ_NOUNMAP)) {
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200929 switch (sdkp->zeroing_mode) {
930 case SD_ZERO_WS16_UNMAP:
Damien Le Moal39051dd2017-12-21 15:43:44 +0900931 return sd_setup_write_same16_cmnd(cmd, true);
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200932 case SD_ZERO_WS10_UNMAP:
Damien Le Moal39051dd2017-12-21 15:43:44 +0900933 return sd_setup_write_same10_cmnd(cmd, true);
Christoph Hellwige4b87832017-04-05 19:21:12 +0200934 }
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500935 }
936
Christoph Hellwig02d26102017-04-05 19:21:02 +0200937 if (sdp->no_write_same)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100938 return BLK_STS_TARGET;
Damien Le Moaled44fd72017-05-08 15:48:19 +0900939
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -0800940 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff)
Damien Le Moal39051dd2017-12-21 15:43:44 +0900941 return sd_setup_write_same16_cmnd(cmd, false);
Damien Le Moaled44fd72017-05-08 15:48:19 +0900942
Damien Le Moal39051dd2017-12-21 15:43:44 +0900943 return sd_setup_write_same10_cmnd(cmd, false);
FUJITA Tomonorif1126e92010-07-01 19:49:18 +0900944}
945
Martin K. Petersen5db44862012-09-18 12:19:32 -0400946static void sd_config_write_same(struct scsi_disk *sdkp)
947{
948 struct request_queue *q = sdkp->disk->queue;
949 unsigned int logical_block_size = sdkp->device->sector_size;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400950
951 if (sdkp->device->no_write_same) {
952 sdkp->max_ws_blocks = 0;
953 goto out;
954 }
955
956 /* Some devices can not handle block counts above 0xffff despite
957 * supporting WRITE SAME(16). Consequently we default to 64k
958 * blocks per I/O unless the device explicitly advertises a
959 * bigger limit.
960 */
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400961 if (sdkp->max_ws_blocks > SD_MAX_WS10_BLOCKS)
962 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
963 (u32)SD_MAX_WS16_BLOCKS);
964 else if (sdkp->ws16 || sdkp->ws10 || sdkp->device->no_report_opcodes)
965 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
966 (u32)SD_MAX_WS10_BLOCKS);
967 else {
968 sdkp->device->no_write_same = 1;
969 sdkp->max_ws_blocks = 0;
970 }
Martin K. Petersen5db44862012-09-18 12:19:32 -0400971
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200972 if (sdkp->lbprz && sdkp->lbpws)
973 sdkp->zeroing_mode = SD_ZERO_WS16_UNMAP;
974 else if (sdkp->lbprz && sdkp->lbpws10)
975 sdkp->zeroing_mode = SD_ZERO_WS10_UNMAP;
976 else if (sdkp->max_ws_blocks)
977 sdkp->zeroing_mode = SD_ZERO_WS;
978 else
979 sdkp->zeroing_mode = SD_ZERO_WRITE;
980
Damien Le Moalb7af62a2017-09-05 20:55:35 +0900981 if (sdkp->max_ws_blocks &&
982 sdkp->physical_block_size > logical_block_size) {
983 /*
984 * Reporting a maximum number of blocks that is not aligned
985 * on the device physical size would cause a large write same
986 * request to be split into physically unaligned chunks by
987 * __blkdev_issue_write_zeroes() and __blkdev_issue_write_same()
988 * even if the caller of these functions took care to align the
989 * large request. So make sure the maximum reported is aligned
990 * to the device physical block size. This is only an optional
991 * optimization for regular disks, but this is mandatory to
992 * avoid failure of large write same requests directed at
993 * sequential write required zones of host-managed ZBC disks.
994 */
995 sdkp->max_ws_blocks =
996 round_down(sdkp->max_ws_blocks,
997 bytes_to_logical(sdkp->device,
998 sdkp->physical_block_size));
999 }
1000
Martin K. Petersen5db44862012-09-18 12:19:32 -04001001out:
Martin K. Petersen66c28f92013-06-06 22:15:55 -04001002 blk_queue_max_write_same_sectors(q, sdkp->max_ws_blocks *
1003 (logical_block_size >> 9));
Christoph Hellwig02d26102017-04-05 19:21:02 +02001004 blk_queue_max_write_zeroes_sectors(q, sdkp->max_ws_blocks *
1005 (logical_block_size >> 9));
Martin K. Petersen5db44862012-09-18 12:19:32 -04001006}
1007
1008/**
1009 * sd_setup_write_same_cmnd - write the same data to multiple blocks
Christoph Hellwig59b11342014-06-28 12:22:22 +02001010 * @cmd: command to prepare
Martin K. Petersen5db44862012-09-18 12:19:32 -04001011 *
Damien Le Moal7529fbb2017-04-24 16:51:09 +09001012 * Will set up either WRITE SAME(10) or WRITE SAME(16) depending on
1013 * the preference indicated by the target device.
Martin K. Petersen5db44862012-09-18 12:19:32 -04001014 **/
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001015static blk_status_t sd_setup_write_same_cmnd(struct scsi_cmnd *cmd)
Martin K. Petersen5db44862012-09-18 12:19:32 -04001016{
Christoph Hellwig59b11342014-06-28 12:22:22 +02001017 struct request *rq = cmd->request;
1018 struct scsi_device *sdp = cmd->device;
Martin K. Petersen5db44862012-09-18 12:19:32 -04001019 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1020 struct bio *bio = rq->bio;
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -08001021 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
1022 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001023 blk_status_t ret;
Martin K. Petersen5db44862012-09-18 12:19:32 -04001024
1025 if (sdkp->device->no_write_same)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001026 return BLK_STS_TARGET;
Martin K. Petersen5db44862012-09-18 12:19:32 -04001027
Kent Overstreeta4ad39b12013-08-07 14:24:32 -07001028 BUG_ON(bio_offset(bio) || bio_iovec(bio).bv_len != sdp->sector_size);
Martin K. Petersen5db44862012-09-18 12:19:32 -04001029
Martin K. Petersen5db44862012-09-18 12:19:32 -04001030 rq->timeout = SD_WRITE_SAME_TIMEOUT;
Martin K. Petersen5db44862012-09-18 12:19:32 -04001031
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -08001032 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff) {
Christoph Hellwig59b11342014-06-28 12:22:22 +02001033 cmd->cmd_len = 16;
1034 cmd->cmnd[0] = WRITE_SAME_16;
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -08001035 put_unaligned_be64(lba, &cmd->cmnd[2]);
1036 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
Martin K. Petersen5db44862012-09-18 12:19:32 -04001037 } else {
Christoph Hellwig59b11342014-06-28 12:22:22 +02001038 cmd->cmd_len = 10;
1039 cmd->cmnd[0] = WRITE_SAME;
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -08001040 put_unaligned_be32(lba, &cmd->cmnd[2]);
1041 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
Martin K. Petersen5db44862012-09-18 12:19:32 -04001042 }
1043
Christoph Hellwig59b11342014-06-28 12:22:22 +02001044 cmd->transfersize = sdp->sector_size;
Christoph Hellwiga25ee542014-06-28 12:29:19 +02001045 cmd->allowed = SD_MAX_RETRIES;
Bart Van Assche08965c22017-01-25 13:43:56 -08001046
1047 /*
1048 * For WRITE SAME the data transferred via the DATA OUT buffer is
1049 * different from the amount of data actually written to the target.
1050 *
1051 * We set up __data_len to the amount of data transferred via the
1052 * DATA OUT buffer so that blk_rq_map_sg sets up the proper S/G list
1053 * to transfer a single sector of data first, but then reset it to
1054 * the amount of data to be written right after so that the I/O path
1055 * knows how much to actually write.
1056 */
1057 rq->__data_len = sdp->sector_size;
1058 ret = scsi_init_io(cmd);
Bart Van Assche84f7a9d2019-01-15 16:49:57 -08001059 rq->__data_len = blk_rq_bytes(rq);
Damien Le Moal29f6ca62017-05-08 14:59:02 +09001060
Bart Van Assche08965c22017-01-25 13:43:56 -08001061 return ret;
Martin K. Petersen5db44862012-09-18 12:19:32 -04001062}
1063
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001064static blk_status_t sd_setup_flush_cmnd(struct scsi_cmnd *cmd)
FUJITA Tomonori90467c22010-07-03 17:45:34 +09001065{
Christoph Hellwiga118c6c2014-06-28 12:08:05 +02001066 struct request *rq = cmd->request;
FUJITA Tomonori90467c22010-07-03 17:45:34 +09001067
Christoph Hellwiga118c6c2014-06-28 12:08:05 +02001068 /* flush requests don't perform I/O, zero the S/G table */
1069 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1070
1071 cmd->cmnd[0] = SYNCHRONIZE_CACHE;
1072 cmd->cmd_len = 10;
1073 cmd->transfersize = 0;
1074 cmd->allowed = SD_MAX_RETRIES;
1075
K. Y. Srinivasan26b9fd82014-07-18 17:11:27 +02001076 rq->timeout = rq->q->rq_timeout * SD_FLUSH_TIMEOUT_MULTIPLIER;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001077 return BLK_STS_OK;
FUJITA Tomonori90467c22010-07-03 17:45:34 +09001078}
1079
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001080static blk_status_t sd_setup_rw32_cmnd(struct scsi_cmnd *cmd, bool write,
1081 sector_t lba, unsigned int nr_blocks,
1082 unsigned char flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083{
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001084 cmd->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
1085 if (unlikely(cmd->cmnd == NULL))
1086 return BLK_STS_RESOURCE;
1087
1088 cmd->cmd_len = SD_EXT_CDB_SIZE;
1089 memset(cmd->cmnd, 0, cmd->cmd_len);
1090
1091 cmd->cmnd[0] = VARIABLE_LENGTH_CMD;
1092 cmd->cmnd[7] = 0x18; /* Additional CDB len */
1093 cmd->cmnd[9] = write ? WRITE_32 : READ_32;
1094 cmd->cmnd[10] = flags;
1095 put_unaligned_be64(lba, &cmd->cmnd[12]);
1096 put_unaligned_be32(lba, &cmd->cmnd[20]); /* Expected Indirect LBA */
1097 put_unaligned_be32(nr_blocks, &cmd->cmnd[28]);
1098
1099 return BLK_STS_OK;
1100}
1101
1102static blk_status_t sd_setup_rw16_cmnd(struct scsi_cmnd *cmd, bool write,
1103 sector_t lba, unsigned int nr_blocks,
1104 unsigned char flags)
1105{
1106 cmd->cmd_len = 16;
1107 cmd->cmnd[0] = write ? WRITE_16 : READ_16;
1108 cmd->cmnd[1] = flags;
1109 cmd->cmnd[14] = 0;
1110 cmd->cmnd[15] = 0;
1111 put_unaligned_be64(lba, &cmd->cmnd[2]);
1112 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
1113
1114 return BLK_STS_OK;
1115}
1116
1117static blk_status_t sd_setup_rw10_cmnd(struct scsi_cmnd *cmd, bool write,
1118 sector_t lba, unsigned int nr_blocks,
1119 unsigned char flags)
1120{
1121 cmd->cmd_len = 10;
1122 cmd->cmnd[0] = write ? WRITE_10 : READ_10;
1123 cmd->cmnd[1] = flags;
1124 cmd->cmnd[6] = 0;
1125 cmd->cmnd[9] = 0;
1126 put_unaligned_be32(lba, &cmd->cmnd[2]);
1127 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
1128
1129 return BLK_STS_OK;
1130}
1131
1132static blk_status_t sd_setup_rw6_cmnd(struct scsi_cmnd *cmd, bool write,
1133 sector_t lba, unsigned int nr_blocks,
1134 unsigned char flags)
1135{
Bart Van Asschedb5db4b2019-01-23 11:12:37 -08001136 /* Avoid that 0 blocks gets translated into 256 blocks. */
1137 if (WARN_ON_ONCE(nr_blocks == 0))
1138 return BLK_STS_IOERR;
1139
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001140 if (unlikely(flags & 0x8)) {
1141 /*
1142 * This happens only if this drive failed 10byte rw
1143 * command with ILLEGAL_REQUEST during operation and
1144 * thus turned off use_10_for_rw.
1145 */
1146 scmd_printk(KERN_ERR, cmd, "FUA write on READ/WRITE(6) drive\n");
1147 return BLK_STS_IOERR;
1148 }
1149
1150 cmd->cmd_len = 6;
1151 cmd->cmnd[0] = write ? WRITE_6 : READ_6;
1152 cmd->cmnd[1] = (lba >> 16) & 0x1f;
1153 cmd->cmnd[2] = (lba >> 8) & 0xff;
1154 cmd->cmnd[3] = lba & 0xff;
1155 cmd->cmnd[4] = nr_blocks;
1156 cmd->cmnd[5] = 0;
1157
1158 return BLK_STS_OK;
1159}
1160
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001161static blk_status_t sd_setup_read_write_cmnd(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162{
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001163 struct request *rq = cmd->request;
1164 struct scsi_device *sdp = cmd->device;
Martin K. Petersene249e422019-01-15 16:50:01 -08001165 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
Martin K. Petersenec029752019-01-15 16:49:59 -08001166 sector_t lba = sectors_to_logical(sdp, blk_rq_pos(rq));
Linus Torvalds18351072008-08-05 21:42:21 -07001167 sector_t threshold;
Martin K. Petersenec029752019-01-15 16:49:59 -08001168 unsigned int nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
Martin K. Petersene249e422019-01-15 16:50:01 -08001169 bool dif, dix;
Martin K. Petersenec029752019-01-15 16:49:59 -08001170 unsigned int mask = logical_to_sectors(sdp, 1) - 1;
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001171 bool write = rq_data_dir(rq) == WRITE;
1172 unsigned char protect, fua;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001173 blk_status_t ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001174
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001175 ret = scsi_init_io(cmd);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001176 if (ret != BLK_STS_OK)
Damien Le Moal39051dd2017-12-21 15:43:44 +09001177 return ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001178
Martin K. Petersene249e422019-01-15 16:50:01 -08001179 if (!scsi_device_online(sdp) || sdp->changed) {
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001180 scmd_printk(KERN_ERR, cmd, "device offline or changed\n");
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001181 return BLK_STS_IOERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 }
1183
Martin K. Petersene249e422019-01-15 16:50:01 -08001184 if (blk_rq_pos(rq) + blk_rq_sectors(rq) > get_capacity(rq->rq_disk)) {
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001185 scmd_printk(KERN_ERR, cmd, "access beyond end of device\n");
Martin K. Petersene249e422019-01-15 16:50:01 -08001186 return BLK_STS_IOERR;
1187 }
1188
1189 if ((blk_rq_pos(rq) & mask) || (blk_rq_sectors(rq) & mask)) {
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001190 scmd_printk(KERN_ERR, cmd, "request not aligned to the logical block size\n");
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001191 return BLK_STS_IOERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001193
Hans de Goedea0899d42008-01-20 11:12:26 +01001194 /*
Martin K. Petersenec029752019-01-15 16:49:59 -08001195 * Some SD card readers can't handle accesses which touch the
1196 * last one or two logical blocks. Split accesses as needed.
Hans de Goedea0899d42008-01-20 11:12:26 +01001197 */
Martin K. Petersenec029752019-01-15 16:49:59 -08001198 threshold = sdkp->capacity - SD_LAST_BUGGY_SECTORS;
Linus Torvalds18351072008-08-05 21:42:21 -07001199
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -08001200 if (unlikely(sdp->last_sector_bug && lba + nr_blocks > threshold)) {
1201 if (lba < threshold) {
Linus Torvalds18351072008-08-05 21:42:21 -07001202 /* Access up to the threshold but not beyond */
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -08001203 nr_blocks = threshold - lba;
Linus Torvalds18351072008-08-05 21:42:21 -07001204 } else {
Martin K. Petersenec029752019-01-15 16:49:59 -08001205 /* Access only a single logical block */
1206 nr_blocks = 1;
Linus Torvalds18351072008-08-05 21:42:21 -07001207 }
1208 }
Hans de Goedea0899d42008-01-20 11:12:26 +01001209
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001210 fua = rq->cmd_flags & REQ_FUA ? 0x8 : 0;
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001211 dix = scsi_prot_sg_count(cmd);
1212 dif = scsi_host_dif_capable(cmd->device->host, sdkp->protection_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Martin K. Petersenc6115292014-09-26 19:20:08 -04001214 if (dif || dix)
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001215 protect = sd_setup_protect_cmnd(cmd, dix, dif);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001216 else
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04001217 protect = 0;
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001218
Christoph Hellwig8475c812016-09-11 19:35:41 +02001219 if (protect && sdkp->protection_type == T10_PI_TYPE2_PROTECTION) {
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001220 ret = sd_setup_rw32_cmnd(cmd, write, lba, nr_blocks,
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001221 protect | fua);
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -08001222 } else if (sdp->use_16_for_rw || (nr_blocks > 0xffff)) {
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001223 ret = sd_setup_rw16_cmnd(cmd, write, lba, nr_blocks,
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001224 protect | fua);
Martin K. Petersenc6c93fd2019-01-15 16:49:58 -08001225 } else if ((nr_blocks > 0xff) || (lba > 0x1fffff) ||
Martin K. Petersene249e422019-01-15 16:50:01 -08001226 sdp->use_10_for_rw || protect) {
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001227 ret = sd_setup_rw10_cmnd(cmd, write, lba, nr_blocks,
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001228 protect | fua);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 } else {
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001230 ret = sd_setup_rw6_cmnd(cmd, write, lba, nr_blocks,
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001231 protect | fua);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 }
Martin K. Petersen78a02f42019-01-15 16:50:00 -08001233
1234 if (unlikely(ret != BLK_STS_OK))
1235 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
1237 /*
1238 * We shouldn't disconnect in the middle of a sector, so with a dumb
1239 * host adapter, it's safe to assume that we can at least transfer
1240 * this many bytes between each connect / disconnect.
1241 */
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001242 cmd->transfersize = sdp->sector_size;
1243 cmd->underflow = nr_blocks << 9;
1244 cmd->allowed = SD_MAX_RETRIES;
1245 cmd->sdb.length = nr_blocks * sdp->sector_size;
Martin K. Petersene249e422019-01-15 16:50:01 -08001246
1247 SCSI_LOG_HLQUEUE(1,
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001248 scmd_printk(KERN_INFO, cmd,
Martin K. Petersene249e422019-01-15 16:50:01 -08001249 "%s: block=%llu, count=%d\n", __func__,
1250 (unsigned long long)blk_rq_pos(rq),
1251 blk_rq_sectors(rq)));
1252 SCSI_LOG_HLQUEUE(2,
Bart Van Asschecf64e5a2019-01-15 16:50:02 -08001253 scmd_printk(KERN_INFO, cmd,
Martin K. Petersene249e422019-01-15 16:50:01 -08001254 "%s %d/%u 512 byte blocks.\n",
1255 write ? "writing" : "reading", nr_blocks,
1256 blk_rq_sectors(rq)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257
1258 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 * This indicates that the command is ready from our end to be
1260 * queued.
1261 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001262 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263}
1264
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001265static blk_status_t sd_init_command(struct scsi_cmnd *cmd)
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001266{
1267 struct request *rq = cmd->request;
1268
Mike Christiec2df40d2016-06-05 14:32:17 -05001269 switch (req_op(rq)) {
1270 case REQ_OP_DISCARD:
Christoph Hellwig81d926e2017-04-05 19:20:59 +02001271 switch (scsi_disk(rq->rq_disk)->provisioning_mode) {
1272 case SD_LBP_UNMAP:
1273 return sd_setup_unmap_cmnd(cmd);
1274 case SD_LBP_WS16:
Christoph Hellwig02d26102017-04-05 19:21:02 +02001275 return sd_setup_write_same16_cmnd(cmd, true);
Christoph Hellwig81d926e2017-04-05 19:20:59 +02001276 case SD_LBP_WS10:
1277 return sd_setup_write_same10_cmnd(cmd, true);
1278 case SD_LBP_ZERO:
1279 return sd_setup_write_same10_cmnd(cmd, false);
1280 default:
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001281 return BLK_STS_TARGET;
Christoph Hellwig81d926e2017-04-05 19:20:59 +02001282 }
Christoph Hellwig02d26102017-04-05 19:21:02 +02001283 case REQ_OP_WRITE_ZEROES:
1284 return sd_setup_write_zeroes_cmnd(cmd);
Mike Christiec2df40d2016-06-05 14:32:17 -05001285 case REQ_OP_WRITE_SAME:
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001286 return sd_setup_write_same_cmnd(cmd);
Mike Christie3a5e02c2016-06-05 14:32:23 -05001287 case REQ_OP_FLUSH:
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001288 return sd_setup_flush_cmnd(cmd);
Mike Christiec2df40d2016-06-05 14:32:17 -05001289 case REQ_OP_READ:
1290 case REQ_OP_WRITE:
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001291 return sd_setup_read_write_cmnd(cmd);
Hannes Reinecke89d94752016-10-18 15:40:34 +09001292 case REQ_OP_ZONE_RESET:
Chaitanya Kulkarnid81e9d42019-08-01 10:26:37 -07001293 return sd_zbc_setup_reset_cmnd(cmd, false);
1294 case REQ_OP_ZONE_RESET_ALL:
1295 return sd_zbc_setup_reset_cmnd(cmd, true);
Mike Christiec2df40d2016-06-05 14:32:17 -05001296 default:
Johannes Thumshirnf1f1fad2018-09-21 09:01:01 +02001297 WARN_ON_ONCE(1);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001298 return BLK_STS_NOTSUPP;
Mike Christiec2df40d2016-06-05 14:32:17 -05001299 }
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001300}
1301
1302static void sd_uninit_command(struct scsi_cmnd *SCpnt)
1303{
1304 struct request *rq = SCpnt->request;
Bart Van Assche14e30622017-12-05 16:57:51 -08001305 u8 *cmnd;
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001306
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001307 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
Jens Axboe61cce6f2018-12-12 06:46:55 -07001308 mempool_free(rq->special_vec.bv_page, sd_page_pool);
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001309
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001310 if (SCpnt->cmnd != scsi_req(rq)->cmd) {
Bart Van Assche14e30622017-12-05 16:57:51 -08001311 cmnd = SCpnt->cmnd;
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001312 SCpnt->cmnd = NULL;
1313 SCpnt->cmd_len = 0;
Bart Van Assche14e30622017-12-05 16:57:51 -08001314 mempool_free(cmnd, sd_cdb_pool);
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001315 }
1316}
1317
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318/**
1319 * sd_open - open a scsi disk device
Damien Le Moal7529fbb2017-04-24 16:51:09 +09001320 * @bdev: Block device of the scsi disk to open
1321 * @mode: FMODE_* mask
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 *
1323 * Returns 0 if successful. Returns a negated errno value in case
1324 * of error.
1325 *
1326 * Note: This can be called from a user context (e.g. fsck(1) )
1327 * or from within the kernel (e.g. as a result of a mount(1) ).
1328 * In the latter case @inode and @filp carry an abridged amount
1329 * of information as noted above.
Arnd Bergmann409f3492010-07-07 16:51:29 +02001330 *
1331 * Locking: called with bdev->bd_mutex held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 **/
Al Viro0338e292008-03-02 10:41:04 -05001333static int sd_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334{
Al Viro0338e292008-03-02 10:41:04 -05001335 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 struct scsi_device *sdev;
1337 int retval;
1338
Al Viro0338e292008-03-02 10:41:04 -05001339 if (!sdkp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 return -ENXIO;
1341
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05001342 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
1344 sdev = sdkp->device;
1345
1346 /*
1347 * If the device is in error recovery, wait until it is done.
1348 * If the device is offline, then disallow any access to it.
1349 */
1350 retval = -ENXIO;
1351 if (!scsi_block_when_processing_errors(sdev))
1352 goto error_out;
1353
1354 if (sdev->removable || sdkp->write_prot)
Al Viro0338e292008-03-02 10:41:04 -05001355 check_disk_change(bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
1357 /*
1358 * If the drive is empty, just let the open fail.
1359 */
1360 retval = -ENOMEDIUM;
Al Viro0338e292008-03-02 10:41:04 -05001361 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 goto error_out;
1363
1364 /*
1365 * If the device has the write protect tab set, have the open fail
1366 * if the user expects to be able to write to the thing.
1367 */
1368 retval = -EROFS;
Al Viro0338e292008-03-02 10:41:04 -05001369 if (sdkp->write_prot && (mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 goto error_out;
1371
1372 /*
1373 * It is possible that the disk changing stuff resulted in
1374 * the device being taken offline. If this is the case,
1375 * report this to the user, and don't pretend that the
1376 * open actually succeeded.
1377 */
1378 retval = -ENXIO;
1379 if (!scsi_device_online(sdev))
1380 goto error_out;
1381
Arnd Bergmann409f3492010-07-07 16:51:29 +02001382 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 if (scsi_block_when_processing_errors(sdev))
1384 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1385 }
1386
1387 return 0;
1388
1389error_out:
1390 scsi_disk_put(sdkp);
1391 return retval;
1392}
1393
1394/**
1395 * sd_release - invoked when the (last) close(2) is called on this
1396 * scsi disk.
Damien Le Moal7529fbb2017-04-24 16:51:09 +09001397 * @disk: disk to release
1398 * @mode: FMODE_* mask
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 *
1400 * Returns 0.
1401 *
1402 * Note: may block (uninterruptible) if error recovery is underway
1403 * on this disk.
Arnd Bergmann409f3492010-07-07 16:51:29 +02001404 *
1405 * Locking: called with bdev->bd_mutex held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 **/
Al Virodb2a1442013-05-05 21:52:57 -04001407static void sd_release(struct gendisk *disk, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 struct scsi_disk *sdkp = scsi_disk(disk);
1410 struct scsi_device *sdev = sdkp->device;
1411
James Bottomley56937f72007-03-11 12:25:33 -05001412 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
Alan Stern7e443312010-09-07 11:27:52 -04001414 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 if (scsi_block_when_processing_errors(sdev))
1416 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1417 }
1418
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 scsi_disk_put(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420}
1421
Christoph Hellwiga885c8c2006-01-08 01:02:50 -08001422static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423{
1424 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1425 struct scsi_device *sdp = sdkp->device;
1426 struct Scsi_Host *host = sdp->host;
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04001427 sector_t capacity = logical_to_sectors(sdp, sdkp->capacity);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 int diskinfo[4];
1429
1430 /* default to most commonly used values */
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04001431 diskinfo[0] = 0x40; /* 1 << 6 */
1432 diskinfo[1] = 0x20; /* 1 << 5 */
1433 diskinfo[2] = capacity >> 11;
1434
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 /* override with calculated, extended default, or driver values */
1436 if (host->hostt->bios_param)
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04001437 host->hostt->bios_param(sdp, bdev, capacity, diskinfo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 else
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04001439 scsicam_bios_param(bdev, capacity, diskinfo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Christoph Hellwiga885c8c2006-01-08 01:02:50 -08001441 geo->heads = diskinfo[0];
1442 geo->sectors = diskinfo[1];
1443 geo->cylinders = diskinfo[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 return 0;
1445}
1446
1447/**
1448 * sd_ioctl - process an ioctl
Damien Le Moal7529fbb2017-04-24 16:51:09 +09001449 * @bdev: target block device
1450 * @mode: FMODE_* mask
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 * @cmd: ioctl command number
1452 * @arg: this is third argument given to ioctl(2) system call.
1453 * Often contains a pointer.
1454 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001455 * Returns 0 if successful (some ioctls return positive numbers on
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 * success as well). Returns a negated errno value in case of error.
1457 *
1458 * Note: most ioctls are forward onto the block subsystem or further
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02001459 * down in the scsi subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 **/
Al Viro0338e292008-03-02 10:41:04 -05001461static int sd_ioctl(struct block_device *bdev, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 unsigned int cmd, unsigned long arg)
1463{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 struct gendisk *disk = bdev->bd_disk;
Nao Nishijimafe2d1852011-08-25 18:04:14 +09001465 struct scsi_disk *sdkp = scsi_disk(disk);
1466 struct scsi_device *sdp = sdkp->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 void __user *p = (void __user *)arg;
1468 int error;
1469
Nao Nishijimafe2d1852011-08-25 18:04:14 +09001470 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1471 "cmd=0x%x\n", disk->disk_name, cmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +01001473 error = scsi_verify_blk_ioctl(bdev, cmd);
1474 if (error < 0)
1475 return error;
1476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 /*
1478 * If we are in the middle of error recovery, don't let anyone
1479 * else try and use this device. Also, if error recovery fails, it
1480 * may try and take the device offline, in which case all further
1481 * access to the device is prohibited.
1482 */
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001483 error = scsi_ioctl_block_when_processing_errors(sdp, cmd,
1484 (mode & FMODE_NDELAY) != 0);
1485 if (error)
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001486 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487
Christoph Hellwigd80210f2017-06-19 14:26:46 +02001488 if (is_sed_ioctl(cmd))
1489 return sed_ioctl(sdkp->opal_dev, cmd, p);
1490
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 /*
1492 * Send SCSI addressing ioctls directly to mid level, send other
1493 * ioctls to block level and then onto mid level if they can't be
1494 * resolved.
1495 */
1496 switch (cmd) {
1497 case SCSI_IOCTL_GET_IDLUN:
1498 case SCSI_IOCTL_GET_BUS_NUMBER:
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001499 error = scsi_ioctl(sdp, cmd, p);
1500 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 default:
Paolo Bonzini577ebb32012-01-12 16:01:27 +01001502 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 if (error != -ENOTTY)
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001504 break;
1505 error = scsi_ioctl(sdp, cmd, p);
1506 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 }
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001508out:
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001509 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510}
1511
1512static void set_media_not_present(struct scsi_disk *sdkp)
1513{
Tejun Heo2bae0092010-12-18 18:42:23 +01001514 if (sdkp->media_present)
1515 sdkp->device->changed = 1;
1516
1517 if (sdkp->device->removable) {
1518 sdkp->media_present = 0;
1519 sdkp->capacity = 0;
1520 }
1521}
1522
1523static int media_not_present(struct scsi_disk *sdkp,
1524 struct scsi_sense_hdr *sshdr)
1525{
1526 if (!scsi_sense_valid(sshdr))
1527 return 0;
1528
1529 /* not invoked for commands that could return deferred errors */
1530 switch (sshdr->sense_key) {
1531 case UNIT_ATTENTION:
1532 case NOT_READY:
1533 /* medium not present */
1534 if (sshdr->asc == 0x3A) {
1535 set_media_not_present(sdkp);
1536 return 1;
1537 }
1538 }
1539 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540}
1541
1542/**
Tejun Heo2bae0092010-12-18 18:42:23 +01001543 * sd_check_events - check media events
1544 * @disk: kernel device descriptor
1545 * @clearing: disk events currently being cleared
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 *
Tejun Heo2bae0092010-12-18 18:42:23 +01001547 * Returns mask of DISK_EVENT_*.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 *
1549 * Note: this function is invoked from the block subsystem.
1550 **/
Tejun Heo2bae0092010-12-18 18:42:23 +01001551static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552{
Hannes Reineckeeb72d0b2016-04-26 08:06:58 +02001553 struct scsi_disk *sdkp = scsi_disk_get(disk);
1554 struct scsi_device *sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 int retval;
1556
Hannes Reineckeeb72d0b2016-04-26 08:06:58 +02001557 if (!sdkp)
1558 return 0;
1559
1560 sdp = sdkp->device;
Tejun Heo2bae0092010-12-18 18:42:23 +01001561 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
1563 /*
1564 * If the device is offline, don't send any commands - just pretend as
1565 * if the command failed. If the device ever comes back online, we
1566 * can deal with it then. It is only because of unrecoverable errors
1567 * that we would ever take a device offline in the first place.
1568 */
Kay Sievers285e9672007-08-14 14:10:39 +02001569 if (!scsi_device_online(sdp)) {
1570 set_media_not_present(sdkp);
Kay Sievers285e9672007-08-14 14:10:39 +02001571 goto out;
1572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
1574 /*
1575 * Using TEST_UNIT_READY enables differentiation between drive with
1576 * no cartridge loaded - NOT READY, drive with changed cartridge -
1577 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1578 *
1579 * Drives that auto spin down. eg iomega jaz 1G, will be started
1580 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1581 * sd_revalidate() is called.
1582 */
James Bottomley001aac22007-12-02 19:10:40 +02001583 if (scsi_block_when_processing_errors(sdp)) {
Christoph Hellwig6fa2b8f2017-02-14 20:15:56 +01001584 struct scsi_sense_hdr sshdr = { 0, };
1585
James Bottomley001aac22007-12-02 19:10:40 +02001586 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
Christoph Hellwig6fa2b8f2017-02-14 20:15:56 +01001587 &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Christoph Hellwig6fa2b8f2017-02-14 20:15:56 +01001589 /* failed to execute TUR, assume media not present */
1590 if (host_byte(retval)) {
1591 set_media_not_present(sdkp);
1592 goto out;
1593 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
Christoph Hellwig6fa2b8f2017-02-14 20:15:56 +01001595 if (media_not_present(sdkp, &sshdr))
1596 goto out;
1597 }
Tejun Heo2bae0092010-12-18 18:42:23 +01001598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 /*
1600 * For removable scsi disk we have to recognise the presence
Tejun Heo2bae0092010-12-18 18:42:23 +01001601 * of a disk in the drive.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 */
Tejun Heo2bae0092010-12-18 18:42:23 +01001603 if (!sdkp->media_present)
1604 sdp->changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 sdkp->media_present = 1;
Kay Sievers285e9672007-08-14 14:10:39 +02001606out:
Alan Stern3ff55882010-09-07 11:44:01 -04001607 /*
Tejun Heo2bae0092010-12-18 18:42:23 +01001608 * sdp->changed is set under the following conditions:
Alan Stern3ff55882010-09-07 11:44:01 -04001609 *
Tejun Heo2bae0092010-12-18 18:42:23 +01001610 * Medium present state has changed in either direction.
1611 * Device has indicated UNIT_ATTENTION.
Alan Stern3ff55882010-09-07 11:44:01 -04001612 */
Tejun Heo2bae0092010-12-18 18:42:23 +01001613 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1614 sdp->changed = 0;
Hannes Reineckeeb72d0b2016-04-26 08:06:58 +02001615 scsi_disk_put(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617}
1618
Derek Basehore4fa83242017-05-11 14:34:24 +02001619static int sd_sync_cache(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 int retries, res;
Martin K. Petersene73aec82007-02-27 22:40:55 -05001622 struct scsi_device *sdp = sdkp->device;
James Bottomley7e660102013-10-04 21:42:24 +00001623 const int timeout = sdp->request_queue->rq_timeout
1624 * SD_FLUSH_TIMEOUT_MULTIPLIER;
Derek Basehore4fa83242017-05-11 14:34:24 +02001625 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
1627 if (!scsi_device_online(sdp))
1628 return -ENODEV;
1629
Derek Basehore4fa83242017-05-11 14:34:24 +02001630 /* caller might not be interested in sense, but we need it */
1631 if (!sshdr)
1632 sshdr = &my_sshdr;
1633
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 for (retries = 3; retries > 0; --retries) {
1635 unsigned char cmd[10] = { 0 };
1636
1637 cmd[0] = SYNCHRONIZE_CACHE;
1638 /*
1639 * Leave the rest of the command zero to indicate
1640 * flush everything.
1641 */
Derek Basehore4fa83242017-05-11 14:34:24 +02001642 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, sshdr,
Christoph Hellwigfcbfffe2017-02-23 16:02:37 +01001643 timeout, SD_MAX_RETRIES, 0, RQF_PM, NULL);
James Bottomleyea73a9f2005-08-28 11:33:52 -05001644 if (res == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 break;
1646 }
1647
Martin K. Petersene73aec82007-02-27 22:40:55 -05001648 if (res) {
Hannes Reineckeef613292014-10-24 14:27:00 +02001649 sd_print_result(sdkp, "Synchronize Cache(10) failed", res);
Oliver Neukum95897912013-09-16 13:28:15 +02001650
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02001651 if (driver_byte(res) == DRIVER_SENSE)
Derek Basehore4fa83242017-05-11 14:34:24 +02001652 sd_print_sense_hdr(sdkp, sshdr);
1653
Oliver Neukum95897912013-09-16 13:28:15 +02001654 /* we need to evaluate the error return */
Derek Basehore4fa83242017-05-11 14:34:24 +02001655 if (scsi_sense_valid(sshdr) &&
1656 (sshdr->asc == 0x3a || /* medium not present */
Oliver Neukum21e3d6c2019-09-03 12:18:39 +02001657 sshdr->asc == 0x20 || /* invalid command */
1658 (sshdr->asc == 0x74 && sshdr->ascq == 0x71))) /* drive is password locked */
Oliver Neukum95897912013-09-16 13:28:15 +02001659 /* this is no error here */
1660 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661
Oliver Neukum95897912013-09-16 13:28:15 +02001662 switch (host_byte(res)) {
1663 /* ignore errors due to racing a disconnection */
1664 case DID_BAD_TARGET:
1665 case DID_NO_CONNECT:
1666 return 0;
1667 /* signal the upper layer it might try again */
1668 case DID_BUS_BUSY:
1669 case DID_IMM_RETRY:
1670 case DID_REQUEUE:
1671 case DID_SOFT_ERROR:
1672 return -EBUSY;
1673 default:
1674 return -EIO;
1675 }
1676 }
Tejun Heo37210502007-03-21 00:07:18 +09001677 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680static void sd_rescan(struct device *dev)
1681{
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01001682 struct scsi_disk *sdkp = dev_get_drvdata(dev);
Alan Stern39b7f1e2005-11-04 14:44:41 -05001683
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01001684 revalidate_disk(sdkp->disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685}
1686
1687
1688#ifdef CONFIG_COMPAT
1689/*
1690 * This gets directly called from VFS. When the ioctl
1691 * is not recognized we go back to the other translation paths.
1692 */
Al Viro0338e292008-03-02 10:41:04 -05001693static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1694 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695{
Al Viro0338e292008-03-02 10:41:04 -05001696 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
Christoph Hellwig21a9d4c2014-10-24 18:39:37 +02001697 int error;
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +01001698
Christoph Hellwig21a9d4c2014-10-24 18:39:37 +02001699 error = scsi_ioctl_block_when_processing_errors(sdev, cmd,
1700 (mode & FMODE_NDELAY) != 0);
1701 if (error)
1702 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 /*
1705 * Let the static ioctl translation table take care of it.
1706 */
Christoph Hellwig21a9d4c2014-10-24 18:39:37 +02001707 if (!sdev->host->hostt->compat_ioctl)
1708 return -ENOIOCTLCMD;
1709 return sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710}
1711#endif
1712
Christoph Hellwig924d55b2015-10-15 14:10:49 +02001713static char sd_pr_type(enum pr_type type)
1714{
1715 switch (type) {
1716 case PR_WRITE_EXCLUSIVE:
1717 return 0x01;
1718 case PR_EXCLUSIVE_ACCESS:
1719 return 0x03;
1720 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1721 return 0x05;
1722 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1723 return 0x06;
1724 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1725 return 0x07;
1726 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1727 return 0x08;
1728 default:
1729 return 0;
1730 }
1731};
1732
1733static int sd_pr_command(struct block_device *bdev, u8 sa,
1734 u64 key, u64 sa_key, u8 type, u8 flags)
1735{
1736 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1737 struct scsi_sense_hdr sshdr;
1738 int result;
1739 u8 cmd[16] = { 0, };
1740 u8 data[24] = { 0, };
1741
1742 cmd[0] = PERSISTENT_RESERVE_OUT;
1743 cmd[1] = sa;
1744 cmd[2] = type;
1745 put_unaligned_be32(sizeof(data), &cmd[5]);
1746
1747 put_unaligned_be64(key, &data[0]);
1748 put_unaligned_be64(sa_key, &data[8]);
1749 data[20] = flags;
1750
1751 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, &data, sizeof(data),
1752 &sshdr, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1753
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02001754 if (driver_byte(result) == DRIVER_SENSE &&
1755 scsi_sense_valid(&sshdr)) {
Christoph Hellwig924d55b2015-10-15 14:10:49 +02001756 sdev_printk(KERN_INFO, sdev, "PR command failed: %d\n", result);
1757 scsi_print_sense_hdr(sdev, NULL, &sshdr);
1758 }
1759
1760 return result;
1761}
1762
1763static int sd_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
1764 u32 flags)
1765{
1766 if (flags & ~PR_FL_IGNORE_KEY)
1767 return -EOPNOTSUPP;
1768 return sd_pr_command(bdev, (flags & PR_FL_IGNORE_KEY) ? 0x06 : 0x00,
1769 old_key, new_key, 0,
Christoph Hellwig01f90dd2016-07-08 21:23:50 +09001770 (1 << 0) /* APTPL */);
Christoph Hellwig924d55b2015-10-15 14:10:49 +02001771}
1772
1773static int sd_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
1774 u32 flags)
1775{
1776 if (flags)
1777 return -EOPNOTSUPP;
1778 return sd_pr_command(bdev, 0x01, key, 0, sd_pr_type(type), 0);
1779}
1780
1781static int sd_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1782{
1783 return sd_pr_command(bdev, 0x02, key, 0, sd_pr_type(type), 0);
1784}
1785
1786static int sd_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
1787 enum pr_type type, bool abort)
1788{
1789 return sd_pr_command(bdev, abort ? 0x05 : 0x04, old_key, new_key,
1790 sd_pr_type(type), 0);
1791}
1792
1793static int sd_pr_clear(struct block_device *bdev, u64 key)
1794{
1795 return sd_pr_command(bdev, 0x03, key, 0, 0, 0);
1796}
1797
1798static const struct pr_ops sd_pr_ops = {
1799 .pr_register = sd_pr_register,
1800 .pr_reserve = sd_pr_reserve,
1801 .pr_release = sd_pr_release,
1802 .pr_preempt = sd_pr_preempt,
1803 .pr_clear = sd_pr_clear,
1804};
1805
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -07001806static const struct block_device_operations sd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 .owner = THIS_MODULE,
Al Viro0338e292008-03-02 10:41:04 -05001808 .open = sd_open,
1809 .release = sd_release,
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001810 .ioctl = sd_ioctl,
Christoph Hellwiga885c8c2006-01-08 01:02:50 -08001811 .getgeo = sd_getgeo,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812#ifdef CONFIG_COMPAT
Al Viro0338e292008-03-02 10:41:04 -05001813 .compat_ioctl = sd_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814#endif
Tejun Heo2bae0092010-12-18 18:42:23 +01001815 .check_events = sd_check_events,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 .revalidate_disk = sd_revalidate_disk,
Tejun Heo72ec24b2010-05-15 20:09:32 +02001817 .unlock_native_capacity = sd_unlock_native_capacity,
Christoph Hellwige76239a2018-10-12 19:08:49 +09001818 .report_zones = sd_zbc_report_zones,
Christoph Hellwig924d55b2015-10-15 14:10:49 +02001819 .pr_ops = &sd_pr_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820};
1821
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001822/**
Hannes Reinecke7a38dc02017-04-06 15:36:29 +02001823 * sd_eh_reset - reset error handling callback
1824 * @scmd: sd-issued command that has failed
1825 *
1826 * This function is called by the SCSI midlayer before starting
1827 * SCSI EH. When counting medium access failures we have to be
1828 * careful to register it only only once per device and SCSI EH run;
1829 * there might be several timed out commands which will cause the
1830 * 'max_medium_access_timeouts' counter to trigger after the first
1831 * SCSI EH run already and set the device to offline.
1832 * So this function resets the internal counter before starting SCSI EH.
1833 **/
1834static void sd_eh_reset(struct scsi_cmnd *scmd)
1835{
1836 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1837
1838 /* New SCSI EH run, reset gate variable */
1839 sdkp->ignore_medium_access_errors = false;
1840}
1841
1842/**
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001843 * sd_eh_action - error handling callback
1844 * @scmd: sd-issued command that has failed
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001845 * @eh_disp: The recovery disposition suggested by the midlayer
1846 *
James Bottomley24510792013-11-11 13:44:53 +01001847 * This function is called by the SCSI midlayer upon completion of an
1848 * error test command (currently TEST UNIT READY). The result of sending
1849 * the eh command is passed in eh_disp. We're looking for devices that
1850 * fail medium access commands but are OK with non access commands like
1851 * test unit ready (so wrongly see the device as having a successful
1852 * recovery)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001853 **/
James Bottomley24510792013-11-11 13:44:53 +01001854static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001855{
1856 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001857 struct scsi_device *sdev = scmd->device;
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001858
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001859 if (!scsi_device_online(sdev) ||
James Bottomley24510792013-11-11 13:44:53 +01001860 !scsi_medium_access_command(scmd) ||
1861 host_byte(scmd->result) != DID_TIME_OUT ||
1862 eh_disp != SUCCESS)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001863 return eh_disp;
1864
1865 /*
1866 * The device has timed out executing a medium access command.
1867 * However, the TEST UNIT READY command sent during error
1868 * handling completed successfully. Either the device is in the
1869 * process of recovering or has it suffered an internal failure
1870 * that prevents access to the storage medium.
1871 */
Hannes Reinecke7a38dc02017-04-06 15:36:29 +02001872 if (!sdkp->ignore_medium_access_errors) {
1873 sdkp->medium_access_timed_out++;
1874 sdkp->ignore_medium_access_errors = true;
1875 }
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001876
1877 /*
1878 * If the device keeps failing read/write commands but TEST UNIT
1879 * READY always completes successfully we assume that medium
1880 * access is no longer possible and take the device offline.
1881 */
1882 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1883 scmd_printk(KERN_ERR, scmd,
1884 "Medium access timeout failure. Offlining disk!\n");
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001885 mutex_lock(&sdev->state_mutex);
1886 scsi_device_set_state(sdev, SDEV_OFFLINE);
1887 mutex_unlock(&sdev->state_mutex);
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001888
Hannes Reineckee8f8d502017-04-06 15:36:30 +02001889 return SUCCESS;
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001890 }
1891
1892 return eh_disp;
1893}
1894
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001895static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1896{
Damien Le Moal6eadc612017-04-24 16:51:10 +09001897 struct request *req = scmd->request;
1898 struct scsi_device *sdev = scmd->device;
1899 unsigned int transferred, good_bytes;
1900 u64 start_lba, end_lba, bad_lba;
1901
1902 /*
1903 * Some commands have a payload smaller than the device logical
1904 * block size (e.g. INQUIRY on a 4K disk).
1905 */
1906 if (scsi_bufflen(scmd) <= sdev->sector_size)
1907 return 0;
1908
1909 /* Check if we have a 'bad_lba' information */
1910 if (!scsi_get_sense_info_fld(scmd->sense_buffer,
1911 SCSI_SENSE_BUFFERSIZE,
1912 &bad_lba))
1913 return 0;
1914
1915 /*
1916 * If the bad lba was reported incorrectly, we have no idea where
1917 * the error is.
1918 */
1919 start_lba = sectors_to_logical(sdev, blk_rq_pos(req));
1920 end_lba = start_lba + bytes_to_logical(sdev, scsi_bufflen(scmd));
1921 if (bad_lba < start_lba || bad_lba >= end_lba)
1922 return 0;
1923
James Bottomleya8733c72010-12-17 15:36:34 -05001924 /*
1925 * resid is optional but mostly filled in. When it's unused,
1926 * its value is zero, so we assume the whole buffer transferred
1927 */
Damien Le Moal6eadc612017-04-24 16:51:10 +09001928 transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001929
Damien Le Moal6eadc612017-04-24 16:51:10 +09001930 /* This computation should always be done in terms of the
1931 * resolution of the device's medium.
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001932 */
Damien Le Moal6eadc612017-04-24 16:51:10 +09001933 good_bytes = logical_to_bytes(sdev, bad_lba - start_lba);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001934
James Bottomleya8733c72010-12-17 15:36:34 -05001935 return min(good_bytes, transferred);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001936}
1937
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938/**
Linus Torvalds7b3d9542008-01-06 10:17:12 -08001939 * sd_done - bottom half handler: called when the lower level
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 * driver has completed (successfully or otherwise) a scsi command.
1941 * @SCpnt: mid-level's per command structure.
1942 *
1943 * Note: potentially run from within an ISR. Must not block.
1944 **/
Linus Torvalds7b3d9542008-01-06 10:17:12 -08001945static int sd_done(struct scsi_cmnd *SCpnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946{
1947 int result = SCpnt->result;
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001948 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
Damien Le Moalc46f0912017-03-01 17:27:00 +09001949 unsigned int sector_size = SCpnt->device->sector_size;
1950 unsigned int resid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 struct scsi_sense_hdr sshdr;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04001952 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
Martin K. Petersen26e85fc2012-09-18 12:19:31 -04001953 struct request *req = SCpnt->request;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 int sense_valid = 0;
1955 int sense_deferred = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956
Hannes Reinecke89d94752016-10-18 15:40:34 +09001957 switch (req_op(req)) {
1958 case REQ_OP_DISCARD:
Christoph Hellwig02d26102017-04-05 19:21:02 +02001959 case REQ_OP_WRITE_ZEROES:
Hannes Reinecke89d94752016-10-18 15:40:34 +09001960 case REQ_OP_WRITE_SAME:
1961 case REQ_OP_ZONE_RESET:
Chaitanya Kulkarnid81e9d42019-08-01 10:26:37 -07001962 case REQ_OP_ZONE_RESET_ALL:
Martin K. Petersen26e85fc2012-09-18 12:19:31 -04001963 if (!result) {
1964 good_bytes = blk_rq_bytes(req);
1965 scsi_set_resid(SCpnt, 0);
1966 } else {
1967 good_bytes = 0;
1968 scsi_set_resid(SCpnt, blk_rq_bytes(req));
1969 }
Hannes Reinecke89d94752016-10-18 15:40:34 +09001970 break;
Damien Le Moalc46f0912017-03-01 17:27:00 +09001971 default:
1972 /*
1973 * In case of bogus fw or device, we could end up having
1974 * an unaligned partial completion. Check this here and force
1975 * alignment.
1976 */
1977 resid = scsi_get_resid(SCpnt);
1978 if (resid & (sector_size - 1)) {
1979 sd_printk(KERN_INFO, sdkp,
1980 "Unaligned partial completion (resid=%u, sector_sz=%u)\n",
1981 resid, sector_size);
Damien Le Moal670d8be2019-08-28 14:35:11 +09001982 scsi_print_command(SCpnt);
Damien Le Moalc46f0912017-03-01 17:27:00 +09001983 resid = min(scsi_bufflen(SCpnt),
1984 round_up(resid, sector_size));
1985 scsi_set_resid(SCpnt, resid);
1986 }
Martin K. Petersen26e85fc2012-09-18 12:19:31 -04001987 }
FUJITA Tomonori6a32a8a2010-07-21 10:29:37 +09001988
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 if (result) {
1990 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1991 if (sense_valid)
1992 sense_deferred = scsi_sense_is_deferred(&sshdr);
1993 }
David Jeffery2a863ba2014-04-10 11:08:30 -04001994 sdkp->medium_access_timed_out = 0;
1995
Luben Tuikov03aba2f2006-06-23 09:39:09 -07001996 if (driver_byte(result) != DRIVER_SENSE &&
1997 (!sense_valid || sense_deferred))
1998 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999
Luben Tuikov03aba2f2006-06-23 09:39:09 -07002000 switch (sshdr.sense_key) {
2001 case HARDWARE_ERROR:
2002 case MEDIUM_ERROR:
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04002003 good_bytes = sd_completed_bytes(SCpnt);
Luben Tuikov03aba2f2006-06-23 09:39:09 -07002004 break;
2005 case RECOVERED_ERROR:
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04002006 good_bytes = scsi_bufflen(SCpnt);
2007 break;
Jamie Wellnitz10dab222008-09-11 21:39:36 -04002008 case NO_SENSE:
2009 /* This indicates a false check condition, so ignore it. An
2010 * unknown amount of data was transferred so treat it as an
2011 * error.
2012 */
Jamie Wellnitz10dab222008-09-11 21:39:36 -04002013 SCpnt->result = 0;
2014 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2015 break;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002016 case ABORTED_COMMAND:
2017 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04002018 good_bytes = sd_completed_bytes(SCpnt);
Luben Tuikov03aba2f2006-06-23 09:39:09 -07002019 break;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002020 case ILLEGAL_REQUEST:
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002021 switch (sshdr.asc) {
2022 case 0x10: /* DIX: Host detected corruption */
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002023 good_bytes = sd_completed_bytes(SCpnt);
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002024 break;
2025 case 0x20: /* INVALID COMMAND OPCODE */
2026 case 0x24: /* INVALID FIELD IN CDB */
2027 switch (SCpnt->cmnd[0]) {
Martin K. Petersen5db44862012-09-18 12:19:32 -04002028 case UNMAP:
2029 sd_config_discard(sdkp, SD_LBP_DISABLE);
2030 break;
2031 case WRITE_SAME_16:
2032 case WRITE_SAME:
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002033 if (SCpnt->cmnd[1] & 8) { /* UNMAP */
Martin K. Petersen5db44862012-09-18 12:19:32 -04002034 sd_config_discard(sdkp, SD_LBP_DISABLE);
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002035 } else {
Martin K. Petersen5db44862012-09-18 12:19:32 -04002036 sdkp->device->no_write_same = 1;
2037 sd_config_write_same(sdkp);
Christoph Hellwige8064022016-10-20 15:12:13 +02002038 req->rq_flags |= RQF_QUIET;
Martin K. Petersen5db44862012-09-18 12:19:32 -04002039 }
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002040 break;
Martin K. Petersen5db44862012-09-18 12:19:32 -04002041 }
2042 }
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002043 break;
Luben Tuikov03aba2f2006-06-23 09:39:09 -07002044 default:
2045 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 }
Hannes Reinecke89d94752016-10-18 15:40:34 +09002047
Luben Tuikov03aba2f2006-06-23 09:39:09 -07002048 out:
Hannes Reinecke89d94752016-10-18 15:40:34 +09002049 if (sd_is_zoned(sdkp))
2050 sd_zbc_complete(SCpnt, good_bytes, &sshdr);
2051
Hannes Reineckeef613292014-10-24 14:27:00 +02002052 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
2053 "sd_done: completed %d of %d bytes\n",
2054 good_bytes, scsi_bufflen(SCpnt)));
2055
Linus Torvalds7b3d9542008-01-06 10:17:12 -08002056 return good_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057}
2058
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059/*
2060 * spinup disk - called only in sd_revalidate_disk()
2061 */
2062static void
Martin K. Petersene73aec82007-02-27 22:40:55 -05002063sd_spinup_disk(struct scsi_disk *sdkp)
James Bottomleyea73a9f2005-08-28 11:33:52 -05002064{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 unsigned char cmd[10];
Alan Stern4451e472005-07-12 10:45:17 -04002066 unsigned long spintime_expire = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 int retries, spintime;
2068 unsigned int the_result;
2069 struct scsi_sense_hdr sshdr;
2070 int sense_valid = 0;
2071
2072 spintime = 0;
2073
2074 /* Spin up drives, as required. Only do this at boot time */
2075 /* Spinup needs to be done for module loads too. */
2076 do {
2077 retries = 0;
2078
2079 do {
2080 cmd[0] = TEST_UNIT_READY;
2081 memset((void *) &cmd[1], 0, 9);
2082
James Bottomleyea73a9f2005-08-28 11:33:52 -05002083 the_result = scsi_execute_req(sdkp->device, cmd,
2084 DMA_NONE, NULL, 0,
2085 &sshdr, SD_TIMEOUT,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002086 SD_MAX_RETRIES, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
Alan Sternb4d38e32006-10-11 16:48:28 -04002088 /*
2089 * If the drive has indicated to us that it
2090 * doesn't have any media in it, don't bother
2091 * with any more polling.
2092 */
2093 if (media_not_present(sdkp, &sshdr))
2094 return;
2095
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 if (the_result)
James Bottomleyea73a9f2005-08-28 11:33:52 -05002097 sense_valid = scsi_sense_valid(&sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 retries++;
2099 } while (retries < 3 &&
2100 (!scsi_status_is_good(the_result) ||
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002101 ((driver_byte(the_result) == DRIVER_SENSE) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
2103
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002104 if (driver_byte(the_result) != DRIVER_SENSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 /* no sense, TUR either succeeded or failed
2106 * with a status error */
Martin K. Petersene73aec82007-02-27 22:40:55 -05002107 if(!spintime && !scsi_status_is_good(the_result)) {
Hannes Reineckeef613292014-10-24 14:27:00 +02002108 sd_print_result(sdkp, "Test Unit Ready failed",
2109 the_result);
Martin K. Petersene73aec82007-02-27 22:40:55 -05002110 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 break;
2112 }
Hannes Reineckeef613292014-10-24 14:27:00 +02002113
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 /*
2115 * The device does not want the automatic start to be issued.
2116 */
Matthew Wilcox33dd6f92009-02-20 06:53:48 -07002117 if (sdkp->device->no_start_on_add)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119
Matthew Wilcox33dd6f92009-02-20 06:53:48 -07002120 if (sense_valid && sshdr.sense_key == NOT_READY) {
2121 if (sshdr.asc == 4 && sshdr.ascq == 3)
2122 break; /* manual intervention required */
2123 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
2124 break; /* standby */
2125 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
2126 break; /* unavailable */
Mahesh Rajashekhara505aa4b2018-04-17 17:03:12 +05302127 if (sshdr.asc == 4 && sshdr.ascq == 0x1b)
2128 break; /* sanitize in progress */
Matthew Wilcox33dd6f92009-02-20 06:53:48 -07002129 /*
2130 * Issue command to spin up drive when not ready
2131 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 if (!spintime) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05002133 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 cmd[0] = START_STOP;
2135 cmd[1] = 1; /* Return immediately */
2136 memset((void *) &cmd[2], 0, 8);
2137 cmd[4] = 1; /* Start spin cycle */
Stefan Richterd2886ea2008-05-11 00:34:07 +02002138 if (sdkp->device->start_stop_pwr_cond)
2139 cmd[4] |= 1 << 4;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002140 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
2141 NULL, 0, &sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002142 SD_TIMEOUT, SD_MAX_RETRIES,
2143 NULL);
Alan Stern4451e472005-07-12 10:45:17 -04002144 spintime_expire = jiffies + 100 * HZ;
2145 spintime = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 /* Wait 1 second for next try */
2148 msleep(1000);
Michał Mirosław3a1d0782017-11-24 18:02:35 +01002149 printk(KERN_CONT ".");
Alan Stern4451e472005-07-12 10:45:17 -04002150
2151 /*
2152 * Wait for USB flash devices with slow firmware.
2153 * Yes, this sense key/ASC combination shouldn't
2154 * occur here. It's characteristic of these devices.
2155 */
2156 } else if (sense_valid &&
2157 sshdr.sense_key == UNIT_ATTENTION &&
2158 sshdr.asc == 0x28) {
2159 if (!spintime) {
2160 spintime_expire = jiffies + 5 * HZ;
2161 spintime = 1;
2162 }
2163 /* Wait 1 second for next try */
2164 msleep(1000);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 } else {
2166 /* we don't understand the sense code, so it's
2167 * probably pointless to loop */
2168 if(!spintime) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05002169 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
2170 sd_print_sense_hdr(sdkp, &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 }
2172 break;
2173 }
2174
Alan Stern4451e472005-07-12 10:45:17 -04002175 } while (spintime && time_before_eq(jiffies, spintime_expire));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176
2177 if (spintime) {
2178 if (scsi_status_is_good(the_result))
Michał Mirosław3a1d0782017-11-24 18:02:35 +01002179 printk(KERN_CONT "ready\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 else
Michał Mirosław3a1d0782017-11-24 18:02:35 +01002181 printk(KERN_CONT "not responding...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 }
2183}
2184
Martin K. Petersene0597d72008-07-17 04:28:34 -04002185/*
2186 * Determine whether disk supports Data Integrity Field.
2187 */
Martin K. Petersenfe542392012-09-21 12:44:12 -04002188static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
Martin K. Petersene0597d72008-07-17 04:28:34 -04002189{
2190 struct scsi_device *sdp = sdkp->device;
2191 u8 type;
Martin K. Petersenfe542392012-09-21 12:44:12 -04002192 int ret = 0;
Martin K. Petersene0597d72008-07-17 04:28:34 -04002193
2194 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
Martin K. Petersenfe542392012-09-21 12:44:12 -04002195 return ret;
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -04002196
2197 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
2198
Christoph Hellwig8475c812016-09-11 19:35:41 +02002199 if (type > T10_PI_TYPE3_PROTECTION)
Martin K. Petersenfe542392012-09-21 12:44:12 -04002200 ret = -ENODEV;
2201 else if (scsi_host_dif_capable(sdp->host, type))
2202 ret = 1;
2203
2204 if (sdkp->first_scan || type != sdkp->protection_type)
2205 switch (ret) {
2206 case -ENODEV:
2207 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
2208 " protection type %u. Disabling disk!\n",
2209 type);
2210 break;
2211 case 1:
2212 sd_printk(KERN_NOTICE, sdkp,
2213 "Enabling DIF Type %u protection\n", type);
2214 break;
2215 case 0:
2216 sd_printk(KERN_NOTICE, sdkp,
2217 "Disabling DIF Type %u protection\n", type);
2218 break;
2219 }
Martin K. Petersene0597d72008-07-17 04:28:34 -04002220
Martin K. Petersenbe922f42008-09-19 18:47:20 -04002221 sdkp->protection_type = type;
2222
Martin K. Petersenfe542392012-09-21 12:44:12 -04002223 return ret;
Martin K. Petersene0597d72008-07-17 04:28:34 -04002224}
2225
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002226static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
2227 struct scsi_sense_hdr *sshdr, int sense_valid,
2228 int the_result)
2229{
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002230 if (driver_byte(the_result) == DRIVER_SENSE)
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002231 sd_print_sense_hdr(sdkp, sshdr);
2232 else
2233 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
2234
2235 /*
2236 * Set dirty bit for removable devices if not ready -
2237 * sometimes drives will not report this properly.
2238 */
2239 if (sdp->removable &&
2240 sense_valid && sshdr->sense_key == NOT_READY)
Tejun Heo2bae0092010-12-18 18:42:23 +01002241 set_media_not_present(sdkp);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002242
2243 /*
2244 * We used to set media_present to 0 here to indicate no media
2245 * in the drive, but some drives fail read capacity even with
2246 * media present, so we can't do that.
2247 */
2248 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
2249}
2250
2251#define RC16_LEN 32
2252#if RC16_LEN > SD_BUF_SIZE
2253#error RC16_LEN must not be more than SD_BUF_SIZE
2254#endif
2255
James Bottomley3233ac12010-04-01 10:30:01 -04002256#define READ_CAPACITY_RETRIES_ON_RESET 10
2257
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002258static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
2259 unsigned char *buffer)
James Bottomleyea73a9f2005-08-28 11:33:52 -05002260{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 unsigned char cmd[16];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 struct scsi_sense_hdr sshdr;
2263 int sense_valid = 0;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002264 int the_result;
James Bottomley3233ac12010-04-01 10:30:01 -04002265 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
Martin K. Petersenea09bcc2009-05-23 11:43:37 -04002266 unsigned int alignment;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002267 unsigned long long lba;
2268 unsigned sector_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269
Hans de Goede5ce524b2010-10-01 14:20:10 -07002270 if (sdp->no_read_capacity_16)
2271 return -EINVAL;
2272
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 do {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002274 memset(cmd, 0, 16);
Hannes Reineckeeb846d92014-11-17 14:25:19 +01002275 cmd[0] = SERVICE_ACTION_IN_16;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002276 cmd[1] = SAI_READ_CAPACITY_16;
2277 cmd[13] = RC16_LEN;
2278 memset(buffer, 0, RC16_LEN);
2279
James Bottomleyea73a9f2005-08-28 11:33:52 -05002280 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002281 buffer, RC16_LEN, &sshdr,
2282 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283
James Bottomleyea73a9f2005-08-28 11:33:52 -05002284 if (media_not_present(sdkp, &sshdr))
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002285 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286
Matthew Wilcox2b301302009-03-12 14:20:30 -04002287 if (the_result) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002288 sense_valid = scsi_sense_valid(&sshdr);
Matthew Wilcox2b301302009-03-12 14:20:30 -04002289 if (sense_valid &&
2290 sshdr.sense_key == ILLEGAL_REQUEST &&
2291 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
2292 sshdr.ascq == 0x00)
2293 /* Invalid Command Operation Code or
2294 * Invalid Field in CDB, just retry
2295 * silently with RC10 */
2296 return -EINVAL;
James Bottomley3233ac12010-04-01 10:30:01 -04002297 if (sense_valid &&
2298 sshdr.sense_key == UNIT_ATTENTION &&
2299 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2300 /* Device reset might occur several times,
2301 * give it one more chance */
2302 if (--reset_retries > 0)
2303 continue;
Matthew Wilcox2b301302009-03-12 14:20:30 -04002304 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 retries--;
2306
2307 } while (the_result && retries);
2308
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002309 if (the_result) {
Hannes Reineckeef613292014-10-24 14:27:00 +02002310 sd_print_result(sdkp, "Read Capacity(16) failed", the_result);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002311 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2312 return -EINVAL;
2313 }
Martin K. Petersene73aec82007-02-27 22:40:55 -05002314
Dave Hansen8f76d152009-04-21 16:43:27 -07002315 sector_size = get_unaligned_be32(&buffer[8]);
2316 lba = get_unaligned_be64(&buffer[0]);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002317
Martin K. Petersenfe542392012-09-21 12:44:12 -04002318 if (sd_read_protection_type(sdkp, buffer) < 0) {
2319 sdkp->capacity = 0;
2320 return -ENODEV;
2321 }
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002322
Martin K. Petersenea09bcc2009-05-23 11:43:37 -04002323 /* Logical blocks per physical block exponent */
Martin K. Petersen526f7c72010-09-28 14:48:47 -04002324 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
Martin K. Petersenea09bcc2009-05-23 11:43:37 -04002325
Hannes Reinecke89d94752016-10-18 15:40:34 +09002326 /* RC basis */
2327 sdkp->rc_basis = (buffer[12] >> 4) & 0x3;
2328
Martin K. Petersenea09bcc2009-05-23 11:43:37 -04002329 /* Lowest aligned logical block */
2330 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2331 blk_queue_alignment_offset(sdp->request_queue, alignment);
2332 if (alignment && sdkp->first_scan)
2333 sd_printk(KERN_NOTICE, sdkp,
2334 "physical block alignment offset: %u\n", alignment);
2335
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002336 if (buffer[14] & 0x80) { /* LBPME */
2337 sdkp->lbpme = 1;
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002338
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002339 if (buffer[14] & 0x40) /* LBPRZ */
2340 sdkp->lbprz = 1;
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002341
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002342 sd_config_discard(sdkp, SD_LBP_WS16);
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002343 }
2344
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002345 sdkp->capacity = lba + 1;
2346 return sector_size;
2347}
2348
2349static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2350 unsigned char *buffer)
2351{
2352 unsigned char cmd[16];
2353 struct scsi_sense_hdr sshdr;
2354 int sense_valid = 0;
2355 int the_result;
James Bottomley3233ac12010-04-01 10:30:01 -04002356 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002357 sector_t lba;
2358 unsigned sector_size;
2359
2360 do {
2361 cmd[0] = READ_CAPACITY;
2362 memset(&cmd[1], 0, 9);
2363 memset(buffer, 0, 8);
2364
2365 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2366 buffer, 8, &sshdr,
2367 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2368
2369 if (media_not_present(sdkp, &sshdr))
2370 return -ENODEV;
2371
James Bottomley3233ac12010-04-01 10:30:01 -04002372 if (the_result) {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002373 sense_valid = scsi_sense_valid(&sshdr);
James Bottomley3233ac12010-04-01 10:30:01 -04002374 if (sense_valid &&
2375 sshdr.sense_key == UNIT_ATTENTION &&
2376 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2377 /* Device reset might occur several times,
2378 * give it one more chance */
2379 if (--reset_retries > 0)
2380 continue;
2381 }
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002382 retries--;
2383
2384 } while (the_result && retries);
2385
2386 if (the_result) {
Hannes Reineckeef613292014-10-24 14:27:00 +02002387 sd_print_result(sdkp, "Read Capacity(10) failed", the_result);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002388 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2389 return -EINVAL;
2390 }
2391
Dave Hansen8f76d152009-04-21 16:43:27 -07002392 sector_size = get_unaligned_be32(&buffer[4]);
2393 lba = get_unaligned_be32(&buffer[0]);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002394
Hans de Goede5ce524b2010-10-01 14:20:10 -07002395 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2396 /* Some buggy (usb cardreader) devices return an lba of
2397 0xffffffff when the want to report a size of 0 (with
2398 which they really mean no media is present) */
2399 sdkp->capacity = 0;
Linus Torvalds5cc10352010-10-22 20:30:48 -07002400 sdkp->physical_block_size = sector_size;
Hans de Goede5ce524b2010-10-01 14:20:10 -07002401 return sector_size;
2402 }
2403
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002404 sdkp->capacity = lba + 1;
Martin K. Petersen526f7c72010-09-28 14:48:47 -04002405 sdkp->physical_block_size = sector_size;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002406 return sector_size;
2407}
2408
Matthew Wilcox2b301302009-03-12 14:20:30 -04002409static int sd_try_rc16_first(struct scsi_device *sdp)
2410{
Hannes Reineckef87146b2010-03-29 09:29:24 +02002411 if (sdp->host->max_cmd_len < 16)
2412 return 0;
Alan Stern6a0bdff2012-06-20 16:04:19 -04002413 if (sdp->try_rc_10_first)
2414 return 0;
Matthew Wilcox2b301302009-03-12 14:20:30 -04002415 if (sdp->scsi_level > SCSI_SPC_2)
2416 return 1;
2417 if (scsi_device_protection(sdp))
2418 return 1;
2419 return 0;
2420}
2421
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002422/*
2423 * read disk capacity
2424 */
2425static void
2426sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2427{
2428 int sector_size;
2429 struct scsi_device *sdp = sdkp->device;
2430
Matthew Wilcox2b301302009-03-12 14:20:30 -04002431 if (sd_try_rc16_first(sdp)) {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002432 sector_size = read_capacity_16(sdkp, sdp, buffer);
2433 if (sector_size == -EOVERFLOW)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 goto got_data;
Matthew Wilcox2b301302009-03-12 14:20:30 -04002435 if (sector_size == -ENODEV)
2436 return;
2437 if (sector_size < 0)
2438 sector_size = read_capacity_10(sdkp, sdp, buffer);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002439 if (sector_size < 0)
2440 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441 } else {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002442 sector_size = read_capacity_10(sdkp, sdp, buffer);
2443 if (sector_size == -EOVERFLOW)
2444 goto got_data;
2445 if (sector_size < 0)
2446 return;
2447 if ((sizeof(sdkp->capacity) > 4) &&
2448 (sdkp->capacity > 0xffffffffULL)) {
2449 int old_sector_size = sector_size;
2450 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2451 "Trying to use READ CAPACITY(16).\n");
2452 sector_size = read_capacity_16(sdkp, sdp, buffer);
2453 if (sector_size < 0) {
2454 sd_printk(KERN_NOTICE, sdkp,
2455 "Using 0xffffffff as device size\n");
2456 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2457 sector_size = old_sector_size;
2458 goto got_data;
2459 }
Martin K. Petersen597d7402018-03-14 12:15:56 -04002460 /* Remember that READ CAPACITY(16) succeeded */
2461 sdp->try_rc_10_first = 0;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002462 }
2463 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464
Alan Stern5c211ca2009-02-18 10:54:44 -05002465 /* Some devices are known to return the total number of blocks,
2466 * not the highest block number. Some devices have versions
2467 * which do this and others which do not. Some devices we might
2468 * suspect of doing this but we don't know for certain.
2469 *
2470 * If we know the reported capacity is wrong, decrement it. If
2471 * we can only guess, then assume the number of blocks is even
2472 * (usually true but not always) and err on the side of lowering
2473 * the capacity.
2474 */
2475 if (sdp->fix_capacity ||
2476 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2477 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2478 "from its reported value: %llu\n",
2479 (unsigned long long) sdkp->capacity);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 --sdkp->capacity;
Oliver Neukum61bf54b2007-02-08 09:04:48 +01002481 }
2482
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483got_data:
2484 if (sector_size == 0) {
2485 sector_size = 512;
Martin K. Petersene73aec82007-02-27 22:40:55 -05002486 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2487 "assuming 512.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488 }
2489
2490 if (sector_size != 512 &&
2491 sector_size != 1024 &&
2492 sector_size != 2048 &&
Mark Hounschell74856fb2015-05-13 10:49:09 +02002493 sector_size != 4096) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05002494 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2495 sector_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 /*
2497 * The user might want to re-format the drive with
2498 * a supported sectorsize. Once this happens, it
2499 * would be relatively trivial to set the thing up.
2500 * For this reason, we leave the thing in the table.
2501 */
2502 sdkp->capacity = 0;
2503 /*
2504 * set a bogus sector size so the normal read/write
2505 * logic in the block layer will eventually refuse any
2506 * request on this device without tripping over power
2507 * of two sector size assumptions
2508 */
2509 sector_size = 512;
2510 }
Martin K. Petersene1defc42009-05-22 17:17:49 -04002511 blk_queue_logical_block_size(sdp->request_queue, sector_size);
Hannes Reinecke89d94752016-10-18 15:40:34 +09002512 blk_queue_physical_block_size(sdp->request_queue,
2513 sdkp->physical_block_size);
2514 sdkp->device->sector_size = sector_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515
Martin K. Petersenca369d52015-11-13 16:46:48 -05002516 if (sdkp->capacity > 0xffffffff)
Martin K. Petersenbcdb2472014-06-03 18:45:51 -04002517 sdp->use_16_for_rw = 1;
Jason J. Herne53ad5702012-11-14 17:03:22 -05002518
Hannes Reinecke89d94752016-10-18 15:40:34 +09002519}
2520
2521/*
2522 * Print disk capacity
2523 */
2524static void
2525sd_print_capacity(struct scsi_disk *sdkp,
2526 sector_t old_capacity)
2527{
2528 int sector_size = sdkp->device->sector_size;
2529 char cap_str_2[10], cap_str_10[10];
2530
Damien Le Moald7e6db22019-01-30 16:07:34 +09002531 if (!sdkp->first_scan && old_capacity == sdkp->capacity)
2532 return;
2533
Hannes Reinecke89d94752016-10-18 15:40:34 +09002534 string_get_size(sdkp->capacity, sector_size,
2535 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
2536 string_get_size(sdkp->capacity, sector_size,
Damien Le Moald7e6db22019-01-30 16:07:34 +09002537 STRING_UNITS_10, cap_str_10, sizeof(cap_str_10));
Hannes Reinecke89d94752016-10-18 15:40:34 +09002538
Damien Le Moald7e6db22019-01-30 16:07:34 +09002539 sd_printk(KERN_NOTICE, sdkp,
2540 "%llu %d-byte logical blocks: (%s/%s)\n",
2541 (unsigned long long)sdkp->capacity,
2542 sector_size, cap_str_10, cap_str_2);
2543
2544 if (sdkp->physical_block_size != sector_size)
Hannes Reinecke89d94752016-10-18 15:40:34 +09002545 sd_printk(KERN_NOTICE, sdkp,
Damien Le Moald7e6db22019-01-30 16:07:34 +09002546 "%u-byte physical blocks\n",
2547 sdkp->physical_block_size);
Hannes Reinecke89d94752016-10-18 15:40:34 +09002548
Damien Le Moald7e6db22019-01-30 16:07:34 +09002549 sd_zbc_print_zones(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550}
2551
2552/* called with buffer of length 512 */
2553static inline int
James Bottomleyea73a9f2005-08-28 11:33:52 -05002554sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
2555 unsigned char *buffer, int len, struct scsi_mode_data *data,
2556 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557{
James Bottomleyea73a9f2005-08-28 11:33:52 -05002558 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
James Bottomley1cf72692005-08-28 11:27:01 -05002559 SD_TIMEOUT, SD_MAX_RETRIES, data,
James Bottomleyea73a9f2005-08-28 11:33:52 -05002560 sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561}
2562
2563/*
2564 * read write protect setting, if possible - called only in sd_revalidate_disk()
Al Viro48970802006-02-26 08:34:10 -06002565 * called with buffer of length SD_BUF_SIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566 */
2567static void
Martin K. Petersene73aec82007-02-27 22:40:55 -05002568sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
James Bottomleyea73a9f2005-08-28 11:33:52 -05002569{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 int res;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002571 struct scsi_device *sdp = sdkp->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 struct scsi_mode_data data;
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002573 int old_wp = sdkp->write_prot;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574
2575 set_disk_ro(sdkp->disk, 0);
James Bottomleyea73a9f2005-08-28 11:33:52 -05002576 if (sdp->skip_ms_page_3f) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002577 sd_first_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 return;
2579 }
2580
James Bottomleyea73a9f2005-08-28 11:33:52 -05002581 if (sdp->use_192_bytes_for_3f) {
2582 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 } else {
2584 /*
2585 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2586 * We have to start carefully: some devices hang if we ask
2587 * for more than is available.
2588 */
James Bottomleyea73a9f2005-08-28 11:33:52 -05002589 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590
2591 /*
2592 * Second attempt: ask for page 0 When only page 0 is
2593 * implemented, a request for page 3F may return Sense Key
2594 * 5: Illegal Request, Sense Code 24: Invalid field in
2595 * CDB.
2596 */
2597 if (!scsi_status_is_good(res))
James Bottomleyea73a9f2005-08-28 11:33:52 -05002598 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599
2600 /*
2601 * Third attempt: ask 255 bytes, as we did earlier.
2602 */
2603 if (!scsi_status_is_good(res))
James Bottomleyea73a9f2005-08-28 11:33:52 -05002604 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
2605 &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 }
2607
2608 if (!scsi_status_is_good(res)) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002609 sd_first_printk(KERN_WARNING, sdkp,
Martin K. Petersene73aec82007-02-27 22:40:55 -05002610 "Test WP failed, assume Write Enabled\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611 } else {
2612 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
Martin K. Petersen8acf6082019-05-20 10:57:18 -04002613 set_disk_ro(sdkp->disk, sdkp->write_prot);
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002614 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2615 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2616 sdkp->write_prot ? "on" : "off");
Andy Shevchenkodf441cc2016-10-22 20:32:30 +03002617 sd_printk(KERN_DEBUG, sdkp, "Mode Sense: %4ph\n", buffer);
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002618 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619 }
2620}
2621
2622/*
2623 * sd_read_cache_type - called only from sd_revalidate_disk()
Al Viro48970802006-02-26 08:34:10 -06002624 * called with buffer of length SD_BUF_SIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625 */
2626static void
Martin K. Petersene73aec82007-02-27 22:40:55 -05002627sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
Al Viro 631e8a12005-05-16 01:59:55 +01002628{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 int len = 0, res;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002630 struct scsi_device *sdp = sdkp->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631
Al Viro 631e8a12005-05-16 01:59:55 +01002632 int dbd;
2633 int modepage;
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002634 int first_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635 struct scsi_mode_data data;
2636 struct scsi_sense_hdr sshdr;
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002637 int old_wce = sdkp->WCE;
2638 int old_rcd = sdkp->RCD;
2639 int old_dpofua = sdkp->DPOFUA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640
James Bottomley39c60a02013-04-24 14:02:53 -07002641
2642 if (sdkp->cache_override)
2643 return;
2644
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002645 first_len = 4;
2646 if (sdp->skip_ms_page_8) {
2647 if (sdp->type == TYPE_RBC)
2648 goto defaults;
2649 else {
2650 if (sdp->skip_ms_page_3f)
2651 goto defaults;
2652 modepage = 0x3F;
2653 if (sdp->use_192_bytes_for_3f)
2654 first_len = 192;
2655 dbd = 0;
2656 }
2657 } else if (sdp->type == TYPE_RBC) {
Al Viro 631e8a12005-05-16 01:59:55 +01002658 modepage = 6;
2659 dbd = 8;
2660 } else {
2661 modepage = 8;
2662 dbd = 0;
2663 }
2664
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 /* cautiously ask */
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002666 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2667 &data, &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668
2669 if (!scsi_status_is_good(res))
2670 goto bad_sense;
2671
Al Viro6d73c852006-02-23 02:03:16 +01002672 if (!data.header_length) {
2673 modepage = 6;
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002674 first_len = 0;
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002675 sd_first_printk(KERN_ERR, sdkp,
2676 "Missing header in MODE_SENSE response\n");
Al Viro6d73c852006-02-23 02:03:16 +01002677 }
2678
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 /* that went OK, now ask for the proper length */
2680 len = data.length;
2681
2682 /*
2683 * We're only interested in the first three bytes, actually.
2684 * But the data cache page is defined for the first 20.
2685 */
2686 if (len < 3)
2687 goto bad_sense;
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002688 else if (len > SD_BUF_SIZE) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002689 sd_first_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002690 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2691 len = SD_BUF_SIZE;
2692 }
2693 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2694 len = 192;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695
2696 /* Get the data */
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002697 if (len > first_len)
2698 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2699 &data, &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700
2701 if (scsi_status_is_good(res)) {
Al Viro 631e8a12005-05-16 01:59:55 +01002702 int offset = data.header_length + data.block_descriptor_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002704 while (offset < len) {
2705 u8 page_code = buffer[offset] & 0x3F;
2706 u8 spf = buffer[offset] & 0x40;
2707
2708 if (page_code == 8 || page_code == 6) {
2709 /* We're interested only in the first 3 bytes.
2710 */
2711 if (len - offset <= 2) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002712 sd_first_printk(KERN_ERR, sdkp,
2713 "Incomplete mode parameter "
2714 "data\n");
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002715 goto defaults;
2716 } else {
2717 modepage = page_code;
2718 goto Page_found;
2719 }
2720 } else {
2721 /* Go to the next page */
2722 if (spf && len - offset > 3)
2723 offset += 4 + (buffer[offset+2] << 8) +
2724 buffer[offset+3];
2725 else if (!spf && len - offset > 1)
2726 offset += 2 + buffer[offset+1];
2727 else {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002728 sd_first_printk(KERN_ERR, sdkp,
2729 "Incomplete mode "
2730 "parameter data\n");
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002731 goto defaults;
2732 }
2733 }
Al Viro48970802006-02-26 08:34:10 -06002734 }
2735
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002736 sd_first_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
Alan Stern984f1732013-09-06 11:49:51 -04002737 goto defaults;
2738
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002739 Page_found:
Al Viro 631e8a12005-05-16 01:59:55 +01002740 if (modepage == 8) {
2741 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2742 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2743 } else {
2744 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2745 sdkp->RCD = 0;
2746 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747
Tejun Heo007365a2006-01-06 09:53:52 +01002748 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
Alan Sternb14bf2d2014-06-30 11:04:21 -04002749 if (sdp->broken_fua) {
2750 sd_first_printk(KERN_NOTICE, sdkp, "Disabling FUA\n");
2751 sdkp->DPOFUA = 0;
Damien Le Moal26f28192017-01-12 15:25:10 +09002752 } else if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw &&
2753 !sdkp->device->use_16_for_rw) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002754 sd_first_printk(KERN_NOTICE, sdkp,
Martin K. Petersene73aec82007-02-27 22:40:55 -05002755 "Uses READ/WRITE(6), disabling FUA\n");
Tejun Heo007365a2006-01-06 09:53:52 +01002756 sdkp->DPOFUA = 0;
2757 }
2758
Sujit Reddy Thumma2eefd572014-08-11 15:40:37 +03002759 /* No cache flush allowed for write protected devices */
2760 if (sdkp->WCE && sdkp->write_prot)
2761 sdkp->WCE = 0;
2762
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002763 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2764 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2765 sd_printk(KERN_NOTICE, sdkp,
2766 "Write cache: %s, read cache: %s, %s\n",
2767 sdkp->WCE ? "enabled" : "disabled",
2768 sdkp->RCD ? "disabled" : "enabled",
2769 sdkp->DPOFUA ? "supports DPO and FUA"
2770 : "doesn't support DPO or FUA");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771
2772 return;
2773 }
2774
2775bad_sense:
James Bottomleyea73a9f2005-08-28 11:33:52 -05002776 if (scsi_sense_valid(&sshdr) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777 sshdr.sense_key == ILLEGAL_REQUEST &&
2778 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
Martin K. Petersene73aec82007-02-27 22:40:55 -05002779 /* Invalid field in CDB */
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002780 sd_first_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 else
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002782 sd_first_printk(KERN_ERR, sdkp,
2783 "Asking for cache data failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784
2785defaults:
Namjae Jeonb81478d2012-07-07 23:05:08 -04002786 if (sdp->wce_default_on) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002787 sd_first_printk(KERN_NOTICE, sdkp,
2788 "Assuming drive cache: write back\n");
Namjae Jeonb81478d2012-07-07 23:05:08 -04002789 sdkp->WCE = 1;
2790 } else {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002791 sd_first_printk(KERN_ERR, sdkp,
2792 "Assuming drive cache: write through\n");
Namjae Jeonb81478d2012-07-07 23:05:08 -04002793 sdkp->WCE = 0;
2794 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 sdkp->RCD = 0;
Al Viro48970802006-02-26 08:34:10 -06002796 sdkp->DPOFUA = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797}
2798
Martin K. Petersene0597d72008-07-17 04:28:34 -04002799/*
2800 * The ATO bit indicates whether the DIF application tag is available
2801 * for use by the operating system.
2802 */
H Hartley Sweeten439d77f2010-08-10 18:01:20 -07002803static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
Martin K. Petersene0597d72008-07-17 04:28:34 -04002804{
2805 int res, offset;
2806 struct scsi_device *sdp = sdkp->device;
2807 struct scsi_mode_data data;
2808 struct scsi_sense_hdr sshdr;
2809
Hannes Reinecke89d94752016-10-18 15:40:34 +09002810 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
Martin K. Petersene0597d72008-07-17 04:28:34 -04002811 return;
2812
2813 if (sdkp->protection_type == 0)
2814 return;
2815
2816 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2817 SD_MAX_RETRIES, &data, &sshdr);
2818
2819 if (!scsi_status_is_good(res) || !data.header_length ||
2820 data.length < 6) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002821 sd_first_printk(KERN_WARNING, sdkp,
Martin K. Petersene0597d72008-07-17 04:28:34 -04002822 "getting Control mode page failed, assume no ATO\n");
2823
2824 if (scsi_sense_valid(&sshdr))
2825 sd_print_sense_hdr(sdkp, &sshdr);
2826
2827 return;
2828 }
2829
2830 offset = data.header_length + data.block_descriptor_length;
2831
2832 if ((buffer[offset] & 0x3f) != 0x0a) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002833 sd_first_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
Martin K. Petersene0597d72008-07-17 04:28:34 -04002834 return;
2835 }
2836
2837 if ((buffer[offset + 5] & 0x80) == 0)
2838 return;
2839
2840 sdkp->ATO = 1;
2841
2842 return;
2843}
2844
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845/**
Martin K. Petersend11b6912009-05-23 11:43:39 -04002846 * sd_read_block_limits - Query disk device for preferred I/O sizes.
Damien Le Moal7529fbb2017-04-24 16:51:09 +09002847 * @sdkp: disk to query
Martin K. Petersend11b6912009-05-23 11:43:39 -04002848 */
2849static void sd_read_block_limits(struct scsi_disk *sdkp)
2850{
2851 unsigned int sector_sz = sdkp->device->sector_size;
Martin K. Petersenbb2d3de2010-03-02 08:44:34 -05002852 const int vpd_len = 64;
James Bottomleye3deec02009-11-03 12:33:07 -06002853 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
Martin K. Petersend11b6912009-05-23 11:43:39 -04002854
James Bottomleye3deec02009-11-03 12:33:07 -06002855 if (!buffer ||
2856 /* Block Limits VPD */
2857 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2858 goto out;
Martin K. Petersend11b6912009-05-23 11:43:39 -04002859
2860 blk_queue_io_min(sdkp->disk->queue,
2861 get_unaligned_be16(&buffer[6]) * sector_sz);
Martin K. Petersenca369d52015-11-13 16:46:48 -05002862
2863 sdkp->max_xfer_blocks = get_unaligned_be32(&buffer[8]);
2864 sdkp->opt_xfer_blocks = get_unaligned_be32(&buffer[12]);
Martin K. Petersend11b6912009-05-23 11:43:39 -04002865
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002866 if (buffer[3] == 0x3c) {
2867 unsigned int lba_count, desc_count;
2868
Martin K. Petersen5db44862012-09-18 12:19:32 -04002869 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002870
2871 if (!sdkp->lbpme)
2872 goto out;
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002873
2874 lba_count = get_unaligned_be32(&buffer[20]);
2875 desc_count = get_unaligned_be32(&buffer[24]);
2876
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002877 if (lba_count && desc_count)
2878 sdkp->max_unmap_blocks = lba_count;
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002879
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002880 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002881
2882 if (buffer[32] & 0x80)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002883 sdkp->unmap_alignment =
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002884 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002885
2886 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2887
2888 if (sdkp->max_unmap_blocks)
2889 sd_config_discard(sdkp, SD_LBP_UNMAP);
2890 else
2891 sd_config_discard(sdkp, SD_LBP_WS16);
2892
2893 } else { /* LBP VPD page tells us what to use */
Martin K. Petersenbcd069b2017-04-05 19:21:25 +02002894 if (sdkp->lbpu && sdkp->max_unmap_blocks)
Martin K. Petersene4613382014-12-05 08:58:03 -05002895 sd_config_discard(sdkp, SD_LBP_UNMAP);
2896 else if (sdkp->lbpws)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002897 sd_config_discard(sdkp, SD_LBP_WS16);
2898 else if (sdkp->lbpws10)
2899 sd_config_discard(sdkp, SD_LBP_WS10);
2900 else
2901 sd_config_discard(sdkp, SD_LBP_DISABLE);
2902 }
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002903 }
2904
James Bottomleye3deec02009-11-03 12:33:07 -06002905 out:
Martin K. Petersend11b6912009-05-23 11:43:39 -04002906 kfree(buffer);
2907}
2908
2909/**
Martin K. Petersen3821d762009-05-23 11:43:38 -04002910 * sd_read_block_characteristics - Query block dev. characteristics
Damien Le Moal7529fbb2017-04-24 16:51:09 +09002911 * @sdkp: disk to query
Martin K. Petersen3821d762009-05-23 11:43:38 -04002912 */
2913static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2914{
Hannes Reinecke89d94752016-10-18 15:40:34 +09002915 struct request_queue *q = sdkp->disk->queue;
James Bottomleye3deec02009-11-03 12:33:07 -06002916 unsigned char *buffer;
Martin K. Petersen3821d762009-05-23 11:43:38 -04002917 u16 rot;
Martin K. Petersenbb2d3de2010-03-02 08:44:34 -05002918 const int vpd_len = 64;
Martin K. Petersen3821d762009-05-23 11:43:38 -04002919
James Bottomleye3deec02009-11-03 12:33:07 -06002920 buffer = kmalloc(vpd_len, GFP_KERNEL);
Martin K. Petersen3821d762009-05-23 11:43:38 -04002921
James Bottomleye3deec02009-11-03 12:33:07 -06002922 if (!buffer ||
2923 /* Block Device Characteristics VPD */
2924 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2925 goto out;
Martin K. Petersen3821d762009-05-23 11:43:38 -04002926
2927 rot = get_unaligned_be16(&buffer[4]);
2928
Mike Snitzerb277da02014-10-04 10:55:32 -06002929 if (rot == 1) {
Bart Van Assche8b904b52018-03-07 17:10:10 -08002930 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
2931 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, q);
Mike Snitzerb277da02014-10-04 10:55:32 -06002932 }
Martin K. Petersen3821d762009-05-23 11:43:38 -04002933
Damien Le Moal68af4122017-01-12 15:25:11 +09002934 if (sdkp->device->type == TYPE_ZBC) {
2935 /* Host-managed */
Hannes Reinecke89d94752016-10-18 15:40:34 +09002936 q->limits.zoned = BLK_ZONED_HM;
Damien Le Moal68af4122017-01-12 15:25:11 +09002937 } else {
2938 sdkp->zoned = (buffer[8] >> 4) & 3;
2939 if (sdkp->zoned == 1)
2940 /* Host-aware */
2941 q->limits.zoned = BLK_ZONED_HA;
2942 else
2943 /*
2944 * Treat drive-managed devices as
2945 * regular block devices.
2946 */
2947 q->limits.zoned = BLK_ZONED_NONE;
2948 }
Hannes Reinecke89d94752016-10-18 15:40:34 +09002949 if (blk_queue_is_zoned(q) && sdkp->first_scan)
2950 sd_printk(KERN_NOTICE, sdkp, "Host-%s zoned block device\n",
2951 q->limits.zoned == BLK_ZONED_HM ? "managed" : "aware");
2952
James Bottomleye3deec02009-11-03 12:33:07 -06002953 out:
Martin K. Petersen3821d762009-05-23 11:43:38 -04002954 kfree(buffer);
2955}
2956
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002957/**
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002958 * sd_read_block_provisioning - Query provisioning VPD page
Damien Le Moal7529fbb2017-04-24 16:51:09 +09002959 * @sdkp: disk to query
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002960 */
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002961static void sd_read_block_provisioning(struct scsi_disk *sdkp)
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002962{
2963 unsigned char *buffer;
2964 const int vpd_len = 8;
2965
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002966 if (sdkp->lbpme == 0)
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002967 return;
2968
2969 buffer = kmalloc(vpd_len, GFP_KERNEL);
2970
2971 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
2972 goto out;
2973
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002974 sdkp->lbpvpd = 1;
2975 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
2976 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
2977 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002978
2979 out:
2980 kfree(buffer);
2981}
2982
Martin K. Petersen5db44862012-09-18 12:19:32 -04002983static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
2984{
Martin K. Petersen66c28f92013-06-06 22:15:55 -04002985 struct scsi_device *sdev = sdkp->device;
2986
Martin K. Petersen54b2b502013-10-23 06:25:40 -04002987 if (sdev->host->no_write_same) {
2988 sdev->no_write_same = 1;
2989
2990 return;
2991 }
2992
Martin K. Petersen66c28f92013-06-06 22:15:55 -04002993 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
Bernd Schubertaf736232013-09-23 14:47:32 +02002994 /* too large values might cause issues with arcmsr */
2995 int vpd_buf_len = 64;
2996
Martin K. Petersen66c28f92013-06-06 22:15:55 -04002997 sdev->no_report_opcodes = 1;
2998
2999 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
3000 * CODES is unsupported and the device has an ATA
3001 * Information VPD page (SAT).
3002 */
Bernd Schubertaf736232013-09-23 14:47:32 +02003003 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
Martin K. Petersen66c28f92013-06-06 22:15:55 -04003004 sdev->no_write_same = 1;
3005 }
3006
3007 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
Martin K. Petersen5db44862012-09-18 12:19:32 -04003008 sdkp->ws16 = 1;
Martin K. Petersen66c28f92013-06-06 22:15:55 -04003009
3010 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
3011 sdkp->ws10 = 1;
Martin K. Petersen5db44862012-09-18 12:19:32 -04003012}
3013
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003014static void sd_read_security(struct scsi_disk *sdkp, unsigned char *buffer)
3015{
3016 struct scsi_device *sdev = sdkp->device;
3017
3018 if (!sdev->security_supported)
3019 return;
3020
3021 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3022 SECURITY_PROTOCOL_IN) == 1 &&
3023 scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3024 SECURITY_PROTOCOL_OUT) == 1)
3025 sdkp->security = 1;
3026}
3027
Martin K. Petersena83da8a2019-02-12 16:21:05 -05003028/*
3029 * Determine the device's preferred I/O size for reads and writes
3030 * unless the reported value is unreasonably small, large, not a
3031 * multiple of the physical block size, or simply garbage.
3032 */
3033static bool sd_validate_opt_xfer_size(struct scsi_disk *sdkp,
3034 unsigned int dev_max)
3035{
3036 struct scsi_device *sdp = sdkp->device;
3037 unsigned int opt_xfer_bytes =
3038 logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3039
Martin K. Petersen1d5de5b2019-03-27 12:11:52 -04003040 if (sdkp->opt_xfer_blocks == 0)
3041 return false;
3042
Martin K. Petersena83da8a2019-02-12 16:21:05 -05003043 if (sdkp->opt_xfer_blocks > dev_max) {
3044 sd_first_printk(KERN_WARNING, sdkp,
3045 "Optimal transfer size %u logical blocks " \
3046 "> dev_max (%u logical blocks)\n",
3047 sdkp->opt_xfer_blocks, dev_max);
3048 return false;
3049 }
3050
3051 if (sdkp->opt_xfer_blocks > SD_DEF_XFER_BLOCKS) {
3052 sd_first_printk(KERN_WARNING, sdkp,
3053 "Optimal transfer size %u logical blocks " \
3054 "> sd driver limit (%u logical blocks)\n",
3055 sdkp->opt_xfer_blocks, SD_DEF_XFER_BLOCKS);
3056 return false;
3057 }
3058
3059 if (opt_xfer_bytes < PAGE_SIZE) {
3060 sd_first_printk(KERN_WARNING, sdkp,
3061 "Optimal transfer size %u bytes < " \
3062 "PAGE_SIZE (%u bytes)\n",
3063 opt_xfer_bytes, (unsigned int)PAGE_SIZE);
3064 return false;
3065 }
3066
3067 if (opt_xfer_bytes & (sdkp->physical_block_size - 1)) {
3068 sd_first_printk(KERN_WARNING, sdkp,
3069 "Optimal transfer size %u bytes not a " \
3070 "multiple of physical block size (%u bytes)\n",
3071 opt_xfer_bytes, sdkp->physical_block_size);
3072 return false;
3073 }
3074
3075 sd_first_printk(KERN_INFO, sdkp, "Optimal transfer size %u bytes\n",
3076 opt_xfer_bytes);
3077 return true;
3078}
3079
Martin K. Petersen3821d762009-05-23 11:43:38 -04003080/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07003081 * sd_revalidate_disk - called the first time a new disk is seen,
3082 * performs disk spin up, read_capacity, etc.
3083 * @disk: struct gendisk we care about
3084 **/
3085static int sd_revalidate_disk(struct gendisk *disk)
3086{
3087 struct scsi_disk *sdkp = scsi_disk(disk);
3088 struct scsi_device *sdp = sdkp->device;
Martin K. Petersenca369d52015-11-13 16:46:48 -05003089 struct request_queue *q = sdkp->disk->queue;
Hannes Reinecke89d94752016-10-18 15:40:34 +09003090 sector_t old_capacity = sdkp->capacity;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091 unsigned char *buffer;
Martin K. Petersenca369d52015-11-13 16:46:48 -05003092 unsigned int dev_max, rw_max;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003093
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05003094 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
3095 "sd_revalidate_disk\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003096
3097 /*
3098 * If the device is offline, don't try and read capacity or any
3099 * of the other niceties.
3100 */
3101 if (!scsi_device_online(sdp))
3102 goto out;
3103
Bernhard Wallea6123f12007-05-21 17:15:26 +02003104 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105 if (!buffer) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05003106 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
3107 "allocation failure.\n");
James Bottomleyea73a9f2005-08-28 11:33:52 -05003108 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003109 }
3110
Martin K. Petersene73aec82007-02-27 22:40:55 -05003111 sd_spinup_disk(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003112
3113 /*
3114 * Without media there is no reason to ask; moreover, some devices
3115 * react badly if we do.
3116 */
3117 if (sdkp->media_present) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05003118 sd_read_capacity(sdkp, buffer);
Martin K. Petersenffd4bc22009-07-29 14:06:53 -04003119
James Bottomleye4a05692019-02-12 08:05:25 -08003120 /*
3121 * set the default to rotational. All non-rotational devices
3122 * support the block characteristics VPD page, which will
3123 * cause this to be updated correctly and any device which
3124 * doesn't support it should be treated as rotational.
3125 */
3126 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
3127 blk_queue_flag_set(QUEUE_FLAG_ADD_RANDOM, q);
3128
Hannes Reinecke5ddfe082016-04-01 08:57:36 +02003129 if (scsi_device_supports_vpd(sdp)) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05003130 sd_read_block_provisioning(sdkp);
Martin K. Petersenffd4bc22009-07-29 14:06:53 -04003131 sd_read_block_limits(sdkp);
3132 sd_read_block_characteristics(sdkp);
Hannes Reinecke89d94752016-10-18 15:40:34 +09003133 sd_zbc_read_zones(sdkp, buffer);
Martin K. Petersenffd4bc22009-07-29 14:06:53 -04003134 }
3135
Hannes Reinecke89d94752016-10-18 15:40:34 +09003136 sd_print_capacity(sdkp, old_capacity);
3137
Martin K. Petersene73aec82007-02-27 22:40:55 -05003138 sd_read_write_protect_flag(sdkp, buffer);
3139 sd_read_cache_type(sdkp, buffer);
Martin K. Petersene0597d72008-07-17 04:28:34 -04003140 sd_read_app_tag_own(sdkp, buffer);
Martin K. Petersen5db44862012-09-18 12:19:32 -04003141 sd_read_write_same(sdkp, buffer);
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003142 sd_read_security(sdkp, buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143 }
Tejun Heo461d4e92006-01-06 09:52:55 +01003144
3145 /*
3146 * We now have all cache related info, determine how we deal
Tejun Heo4913efe2010-09-03 11:56:16 +02003147 * with flush requests.
Tejun Heo461d4e92006-01-06 09:52:55 +01003148 */
Vaughan Caocb2fb682014-06-03 17:37:30 +08003149 sd_set_flush_flag(sdkp);
Tejun Heo461d4e92006-01-06 09:52:55 +01003150
Martin K. Petersenca369d52015-11-13 16:46:48 -05003151 /* Initial block count limit based on CDB TRANSFER LENGTH field size. */
3152 dev_max = sdp->use_16_for_rw ? SD_MAX_XFER_BLOCKS : SD_DEF_XFER_BLOCKS;
Brian King3a9794d2015-01-29 15:54:40 -06003153
Martin K. Petersenca369d52015-11-13 16:46:48 -05003154 /* Some devices report a maximum block count for READ/WRITE requests. */
3155 dev_max = min_not_zero(dev_max, sdkp->max_xfer_blocks);
3156 q->limits.max_dev_sectors = logical_to_sectors(sdp, dev_max);
3157
Martin K. Petersena83da8a2019-02-12 16:21:05 -05003158 if (sd_validate_opt_xfer_size(sdkp, dev_max)) {
Martin K. Petersen6b7e9cd2016-05-12 22:17:34 -04003159 q->limits.io_opt = logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3160 rw_max = logical_to_sectors(sdp, sdkp->opt_xfer_blocks);
3161 } else
Fam Zheng67804142017-03-28 12:41:26 +08003162 rw_max = min_not_zero(logical_to_sectors(sdp, dev_max),
3163 (sector_t)BLK_DEF_MAX_SECTORS);
Martin K. Petersenca369d52015-11-13 16:46:48 -05003164
Martin K. Petersen77082ca2017-09-27 21:38:59 -04003165 /* Do not exceed controller limit */
3166 rw_max = min(rw_max, queue_max_hw_sectors(q));
3167
3168 /*
3169 * Only update max_sectors if previously unset or if the current value
3170 * exceeds the capabilities of the hardware.
3171 */
3172 if (sdkp->first_scan ||
3173 q->limits.max_sectors > q->limits.max_dev_sectors ||
3174 q->limits.max_sectors > q->limits.max_hw_sectors)
3175 q->limits.max_sectors = rw_max;
3176
3177 sdkp->first_scan = 0;
Martin K. Petersen4f258a42015-06-23 12:13:59 -04003178
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04003179 set_capacity(disk, logical_to_sectors(sdp, sdkp->capacity));
Martin K. Petersen5db44862012-09-18 12:19:32 -04003180 sd_config_write_same(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003181 kfree(buffer);
3182
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183 out:
3184 return 0;
3185}
3186
3187/**
Tejun Heo72ec24b2010-05-15 20:09:32 +02003188 * sd_unlock_native_capacity - unlock native capacity
3189 * @disk: struct gendisk to set capacity for
3190 *
3191 * Block layer calls this function if it detects that partitions
3192 * on @disk reach beyond the end of the device. If the SCSI host
3193 * implements ->unlock_native_capacity() method, it's invoked to
3194 * give it a chance to adjust the device capacity.
3195 *
3196 * CONTEXT:
3197 * Defined by block layer. Might sleep.
3198 */
3199static void sd_unlock_native_capacity(struct gendisk *disk)
3200{
3201 struct scsi_device *sdev = scsi_disk(disk)->device;
3202
3203 if (sdev->host->hostt->unlock_native_capacity)
3204 sdev->host->hostt->unlock_native_capacity(sdev);
3205}
3206
3207/**
Tejun Heo3e1a7ff2008-08-25 19:56:17 +09003208 * sd_format_disk_name - format disk name
3209 * @prefix: name prefix - ie. "sd" for SCSI disks
3210 * @index: index of the disk to format name for
3211 * @buf: output buffer
3212 * @buflen: length of the output buffer
3213 *
3214 * SCSI disk names starts at sda. The 26th device is sdz and the
3215 * 27th is sdaa. The last one for two lettered suffix is sdzz
3216 * which is followed by sdaaa.
3217 *
3218 * This is basically 26 base counting with one extra 'nil' entry
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08003219 * at the beginning from the second digit on and can be
Tejun Heo3e1a7ff2008-08-25 19:56:17 +09003220 * determined using similar method as 26 base conversion with the
3221 * index shifted -1 after each digit is computed.
3222 *
3223 * CONTEXT:
3224 * Don't care.
3225 *
3226 * RETURNS:
3227 * 0 on success, -errno on failure.
3228 */
3229static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
3230{
3231 const int base = 'z' - 'a' + 1;
3232 char *begin = buf + strlen(prefix);
3233 char *end = buf + buflen;
3234 char *p;
3235 int unit;
3236
3237 p = end - 1;
3238 *p = '\0';
3239 unit = base;
3240 do {
3241 if (p == begin)
3242 return -EINVAL;
3243 *--p = 'a' + (index % unit);
3244 index = (index / unit) - 1;
3245 } while (index >= 0);
3246
3247 memmove(begin, p, end - p);
3248 memcpy(buf, prefix, strlen(prefix));
3249
3250 return 0;
3251}
3252
3253/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254 * sd_probe - called during driver initialization and whenever a
3255 * new scsi device is attached to the system. It is called once
3256 * for each scsi device (not just disks) present.
3257 * @dev: pointer to device object
3258 *
3259 * Returns 0 if successful (or not interested in this scsi device
3260 * (e.g. scanner)); 1 when there is an error.
3261 *
3262 * Note: this function is invoked from the scsi mid-level.
3263 * This function sets up the mapping between a given
3264 * <host,channel,id,lun> (found in sdp) and new device name
3265 * (e.g. /dev/sda). More precisely it is the block device major
3266 * and minor number that is chosen here.
3267 *
Petr Uzel2db93ce2012-02-24 16:56:54 +01003268 * Assume sd_probe is not re-entrant (for time being)
3269 * Also think about sd_probe() and sd_remove() running coincidentally.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270 **/
3271static int sd_probe(struct device *dev)
3272{
3273 struct scsi_device *sdp = to_scsi_device(dev);
3274 struct scsi_disk *sdkp;
3275 struct gendisk *gd;
H Hartley Sweeten439d77f2010-08-10 18:01:20 -07003276 int index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277 int error;
3278
Subhash Jadavani6fe8c1d2014-09-10 14:54:09 +03003279 scsi_autopm_get_device(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280 error = -ENODEV;
Hannes Reinecke89d94752016-10-18 15:40:34 +09003281 if (sdp->type != TYPE_DISK &&
3282 sdp->type != TYPE_ZBC &&
3283 sdp->type != TYPE_MOD &&
3284 sdp->type != TYPE_RBC)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003285 goto out;
3286
Hannes Reinecke89d94752016-10-18 15:40:34 +09003287#ifndef CONFIG_BLK_DEV_ZONED
3288 if (sdp->type == TYPE_ZBC)
3289 goto out;
3290#endif
James Bottomley9ccfc752005-10-02 11:45:08 -05003291 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
Petr Uzel2db93ce2012-02-24 16:56:54 +01003292 "sd_probe\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003293
3294 error = -ENOMEM;
Jes Sorensen24669f752006-01-16 10:31:18 -05003295 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003296 if (!sdkp)
3297 goto out;
3298
Tejun Heo689d6fa2008-08-25 19:56:16 +09003299 gd = alloc_disk(SD_MINORS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300 if (!gd)
Jan Karac01228d2017-03-08 17:48:34 +01003301 goto out_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302
Matthew Wilcox94015082018-06-11 15:26:27 -04003303 index = ida_alloc(&sd_index_ida, GFP_KERNEL);
3304 if (index < 0) {
Dave Kleikamp21208ae2011-10-19 11:49:04 -05003305 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306 goto out_put;
Michael Reed1a03ae02010-09-20 11:20:22 -05003307 }
3308
Tejun Heo3e1a7ff2008-08-25 19:56:17 +09003309 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
Dave Kleikamp21208ae2011-10-19 11:49:04 -05003310 if (error) {
3311 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
Tejun Heof27bac22008-07-14 14:59:30 +09003312 goto out_free_index;
Dave Kleikamp21208ae2011-10-19 11:49:04 -05003313 }
Tejun Heof27bac22008-07-14 14:59:30 +09003314
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315 sdkp->device = sdp;
3316 sdkp->driver = &sd_template;
3317 sdkp->disk = gd;
3318 sdkp->index = index;
Arnd Bergmann409f3492010-07-07 16:51:29 +02003319 atomic_set(&sdkp->openers, 0);
Josh Hunt9e1a1532012-06-09 07:03:39 -07003320 atomic_set(&sdkp->device->ioerr_cnt, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003321
James Bottomley601e7632009-05-26 20:35:48 +00003322 if (!sdp->request_queue->rq_timeout) {
3323 if (sdp->type != TYPE_MOD)
3324 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
3325 else
3326 blk_queue_rq_timeout(sdp->request_queue,
3327 SD_MOD_TIMEOUT);
3328 }
3329
3330 device_initialize(&sdkp->dev);
Alan Stern478a8a02010-06-16 14:52:17 -04003331 sdkp->dev.parent = dev;
James Bottomley601e7632009-05-26 20:35:48 +00003332 sdkp->dev.class = &sd_disk_class;
Kees Cook02aa2a32013-07-03 15:04:56 -07003333 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
James Bottomley601e7632009-05-26 20:35:48 +00003334
Dan Carpenterdee05862015-01-19 17:41:12 +03003335 error = device_add(&sdkp->dev);
3336 if (error)
James Bottomley601e7632009-05-26 20:35:48 +00003337 goto out_free_index;
3338
Alan Stern478a8a02010-06-16 14:52:17 -04003339 get_device(dev);
3340 dev_set_drvdata(dev, sdkp);
James Bottomley601e7632009-05-26 20:35:48 +00003341
Bart Van Assche82a54da2019-04-30 14:39:19 -07003342 gd->major = sd_major((index & 0xf0) >> 4);
3343 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
3344
3345 gd->fops = &sd_fops;
3346 gd->private_data = &sdkp->driver;
3347 gd->queue = sdkp->device->request_queue;
3348
3349 /* defaults, until the device tells us otherwise */
3350 sdp->sector_size = 512;
3351 sdkp->capacity = 0;
3352 sdkp->media_present = 1;
3353 sdkp->write_prot = 0;
3354 sdkp->cache_override = 0;
3355 sdkp->WCE = 0;
3356 sdkp->RCD = 0;
3357 sdkp->ATO = 0;
3358 sdkp->first_scan = 1;
3359 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
3360
3361 sd_revalidate_disk(gd);
3362
3363 gd->flags = GENHD_FL_EXT_DEVT;
3364 if (sdp->removable) {
3365 gd->flags |= GENHD_FL_REMOVABLE;
3366 gd->events |= DISK_EVENT_MEDIA_CHANGE;
3367 gd->event_flags = DISK_EVENT_FLAG_POLL | DISK_EVENT_FLAG_UEVENT;
3368 }
3369
3370 blk_pm_runtime_init(sdp->request_queue, dev);
Stanley Chuc74f8052019-09-16 23:56:49 +08003371 if (sdp->rpm_autosuspend) {
3372 pm_runtime_set_autosuspend_delay(dev,
3373 sdp->host->hostt->rpm_autosuspend_delay);
3374 }
Bart Van Assche82a54da2019-04-30 14:39:19 -07003375 device_add_disk(dev, gd, NULL);
3376 if (sdkp->capacity)
3377 sd_dif_config_host(sdkp);
3378
3379 sd_revalidate_disk(gd);
3380
3381 if (sdkp->security) {
3382 sdkp->opal_dev = init_opal_dev(sdp, &sd_sec_submit);
3383 if (sdkp->opal_dev)
3384 sd_printk(KERN_NOTICE, sdkp, "supports TCG Opal\n");
3385 }
3386
3387 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
3388 sdp->removable ? "removable " : "");
3389 scsi_autopm_put_device(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003390
3391 return 0;
3392
Tejun Heof27bac22008-07-14 14:59:30 +09003393 out_free_index:
Matthew Wilcox94015082018-06-11 15:26:27 -04003394 ida_free(&sd_index_ida, index);
James Bottomley6bdaa1f2006-03-18 14:14:21 -06003395 out_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003396 put_disk(gd);
Colin Ian Kingf1703962017-02-03 19:38:54 +00003397 out_free:
3398 kfree(sdkp);
James Bottomley6bdaa1f2006-03-18 14:14:21 -06003399 out:
Subhash Jadavani6fe8c1d2014-09-10 14:54:09 +03003400 scsi_autopm_put_device(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003401 return error;
3402}
3403
3404/**
3405 * sd_remove - called whenever a scsi disk (previously recognized by
3406 * sd_probe) is detached from the system. It is called (potentially
3407 * multiple times) during sd module unload.
John Pittmanf2a33132017-01-12 16:17:20 -05003408 * @dev: pointer to device object
Linus Torvalds1da177e2005-04-16 15:20:36 -07003409 *
3410 * Note: this function is invoked from the scsi mid-level.
3411 * This function potentially frees up a device name (e.g. /dev/sdc)
3412 * that could be re-used by a subsequent sd_probe().
3413 * This function is not called when the built-in sd driver is "exit-ed".
3414 **/
3415static int sd_remove(struct device *dev)
3416{
James Bottomley601e7632009-05-26 20:35:48 +00003417 struct scsi_disk *sdkp;
Hannes Reinecke0761df92013-05-10 11:06:16 +02003418 dev_t devt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003419
James Bottomley601e7632009-05-26 20:35:48 +00003420 sdkp = dev_get_drvdata(dev);
Hannes Reinecke0761df92013-05-10 11:06:16 +02003421 devt = disk_devt(sdkp->disk);
Alan Stern478a8a02010-06-16 14:52:17 -04003422 scsi_autopm_get_device(sdkp->device);
3423
Dan Williams3c31b522014-04-10 15:30:35 -07003424 async_synchronize_full_domain(&scsi_sd_pm_domain);
Tony Jonesee959b02008-02-22 00:13:36 +01003425 device_del(&sdkp->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003426 del_gendisk(sdkp->disk);
3427 sd_shutdown(dev);
Alan Stern39b7f1e2005-11-04 14:44:41 -05003428
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003429 free_opal_dev(sdkp->opal_dev);
3430
Hannes Reinecke0761df92013-05-10 11:06:16 +02003431 blk_register_region(devt, SD_MINORS, NULL,
3432 sd_default_probe, NULL, NULL);
3433
Arjan van de Ven0b950672006-01-11 13:16:10 +01003434 mutex_lock(&sd_ref_mutex);
Alan Stern39b7f1e2005-11-04 14:44:41 -05003435 dev_set_drvdata(dev, NULL);
Tony Jonesee959b02008-02-22 00:13:36 +01003436 put_device(&sdkp->dev);
Arjan van de Ven0b950672006-01-11 13:16:10 +01003437 mutex_unlock(&sd_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003438
3439 return 0;
3440}
3441
3442/**
3443 * scsi_disk_release - Called to free the scsi_disk structure
Tony Jonesee959b02008-02-22 00:13:36 +01003444 * @dev: pointer to embedded class device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003445 *
Arjan van de Ven0b950672006-01-11 13:16:10 +01003446 * sd_ref_mutex must be held entering this routine. Because it is
Linus Torvalds1da177e2005-04-16 15:20:36 -07003447 * called on last put, you should always use the scsi_disk_get()
3448 * scsi_disk_put() helpers which manipulate the semaphore directly
Tony Jonesee959b02008-02-22 00:13:36 +01003449 * and never do a direct put_device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003450 **/
Tony Jonesee959b02008-02-22 00:13:36 +01003451static void scsi_disk_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003452{
Tony Jonesee959b02008-02-22 00:13:36 +01003453 struct scsi_disk *sdkp = to_scsi_disk(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003454 struct gendisk *disk = sdkp->disk;
Bart Van Asschec14a5722019-03-25 10:01:46 -07003455 struct request_queue *q = disk->queue;
3456
Matthew Wilcox94015082018-06-11 15:26:27 -04003457 ida_free(&sd_index_ida, sdkp->index);
Jan Karac01228d2017-03-08 17:48:34 +01003458
Bart Van Asschec14a5722019-03-25 10:01:46 -07003459 /*
3460 * Wait until all requests that are in progress have completed.
3461 * This is necessary to avoid that e.g. scsi_end_request() crashes
3462 * due to clearing the disk->private_data pointer. Wait from inside
3463 * scsi_disk_release() instead of from sd_release() to avoid that
3464 * freezing and unfreezing the request queue affects user space I/O
3465 * in case multiple processes open a /dev/sd... node concurrently.
3466 */
3467 blk_mq_freeze_queue(q);
3468 blk_mq_unfreeze_queue(q);
3469
Linus Torvalds1da177e2005-04-16 15:20:36 -07003470 disk->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471 put_disk(disk);
Alan Stern39b7f1e2005-11-04 14:44:41 -05003472 put_device(&sdkp->device->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003473
3474 kfree(sdkp);
3475}
3476
James Bottomleycc5d2c82007-03-20 12:26:03 -05003477static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003478{
3479 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3480 struct scsi_sense_hdr sshdr;
James Bottomleycc5d2c82007-03-20 12:26:03 -05003481 struct scsi_device *sdp = sdkp->device;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003482 int res;
3483
3484 if (start)
3485 cmd[4] |= 1; /* START */
3486
Stefan Richterd2886ea2008-05-11 00:34:07 +02003487 if (sdp->start_stop_pwr_cond)
3488 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3489
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003490 if (!scsi_device_online(sdp))
3491 return -ENODEV;
3492
Christoph Hellwigfcbfffe2017-02-23 16:02:37 +01003493 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, &sshdr,
3494 SD_TIMEOUT, SD_MAX_RETRIES, 0, RQF_PM, NULL);
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003495 if (res) {
Hannes Reineckeef613292014-10-24 14:27:00 +02003496 sd_print_result(sdkp, "Start/Stop Unit failed", res);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02003497 if (driver_byte(res) == DRIVER_SENSE)
James Bottomleycc5d2c82007-03-20 12:26:03 -05003498 sd_print_sense_hdr(sdkp, &sshdr);
Oliver Neukum95897912013-09-16 13:28:15 +02003499 if (scsi_sense_valid(&sshdr) &&
3500 /* 0x3a is medium not present */
3501 sshdr.asc == 0x3a)
3502 res = 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003503 }
3504
Oliver Neukum95897912013-09-16 13:28:15 +02003505 /* SCSI error codes must not go to the generic layer */
3506 if (res)
3507 return -EIO;
3508
3509 return 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003510}
3511
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512/*
3513 * Send a SYNCHRONIZE CACHE instruction down to the device through
3514 * the normal SCSI command structure. Wait for the command to
3515 * complete.
3516 */
3517static void sd_shutdown(struct device *dev)
3518{
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003519 struct scsi_disk *sdkp = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003520
3521 if (!sdkp)
3522 return; /* this can happen */
3523
Lin Ming54f575882011-12-05 09:20:26 +08003524 if (pm_runtime_suspended(dev))
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003525 return;
Lin Ming54f575882011-12-05 09:20:26 +08003526
Oliver Neukum95897912013-09-16 13:28:15 +02003527 if (sdkp->WCE && sdkp->media_present) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05003528 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
Derek Basehore4fa83242017-05-11 14:34:24 +02003529 sd_sync_cache(sdkp, NULL);
Alan Stern39b7f1e2005-11-04 14:44:41 -05003530 }
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003531
James Bottomleycc5d2c82007-03-20 12:26:03 -05003532 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3533 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3534 sd_start_stop_device(sdkp, 0);
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003535 }
Alan Stern39b7f1e2005-11-04 14:44:41 -05003536}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003537
Oliver Neukum95897912013-09-16 13:28:15 +02003538static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003539{
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003540 struct scsi_disk *sdkp = dev_get_drvdata(dev);
Derek Basehore4fa83242017-05-11 14:34:24 +02003541 struct scsi_sense_hdr sshdr;
Alan Stern09ff92f2007-05-21 09:55:04 -04003542 int ret = 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003543
Alan Stern13b43892016-01-20 11:26:01 -05003544 if (!sdkp) /* E.g.: runtime suspend following sd_remove() */
3545 return 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003546
Oliver Neukum95897912013-09-16 13:28:15 +02003547 if (sdkp->WCE && sdkp->media_present) {
James Bottomleycc5d2c82007-03-20 12:26:03 -05003548 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
Derek Basehore4fa83242017-05-11 14:34:24 +02003549 ret = sd_sync_cache(sdkp, &sshdr);
3550
Oliver Neukum95897912013-09-16 13:28:15 +02003551 if (ret) {
3552 /* ignore OFFLINE device */
3553 if (ret == -ENODEV)
Derek Basehore4fa83242017-05-11 14:34:24 +02003554 return 0;
3555
3556 if (!scsi_sense_valid(&sshdr) ||
3557 sshdr.sense_key != ILLEGAL_REQUEST)
3558 return ret;
3559
3560 /*
3561 * sshdr.sense_key == ILLEGAL_REQUEST means this drive
3562 * doesn't support sync. There's not much to do and
3563 * suspend shouldn't fail.
3564 */
Bart Van Asscheed91f7e2017-08-25 13:46:34 -07003565 ret = 0;
Oliver Neukum95897912013-09-16 13:28:15 +02003566 }
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003567 }
3568
Aaron Lu691e3d32012-11-09 15:27:55 +08003569 if (sdkp->device->manage_start_stop) {
James Bottomleycc5d2c82007-03-20 12:26:03 -05003570 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
Oliver Neukum95897912013-09-16 13:28:15 +02003571 /* an error is not worth aborting a system sleep */
James Bottomleycc5d2c82007-03-20 12:26:03 -05003572 ret = sd_start_stop_device(sdkp, 0);
Oliver Neukum95897912013-09-16 13:28:15 +02003573 if (ignore_stop_errors)
3574 ret = 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003575 }
3576
Alan Stern09ff92f2007-05-21 09:55:04 -04003577 return ret;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003578}
3579
Oliver Neukum95897912013-09-16 13:28:15 +02003580static int sd_suspend_system(struct device *dev)
3581{
3582 return sd_suspend_common(dev, true);
3583}
3584
3585static int sd_suspend_runtime(struct device *dev)
3586{
3587 return sd_suspend_common(dev, false);
3588}
3589
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003590static int sd_resume(struct device *dev)
3591{
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003592 struct scsi_disk *sdkp = dev_get_drvdata(dev);
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003593 int ret;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003594
Alan Stern13b43892016-01-20 11:26:01 -05003595 if (!sdkp) /* E.g.: runtime resume at the start of sd_probe() */
3596 return 0;
3597
James Bottomleycc5d2c82007-03-20 12:26:03 -05003598 if (!sdkp->device->manage_start_stop)
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003599 return 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003600
James Bottomleycc5d2c82007-03-20 12:26:03 -05003601 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003602 ret = sd_start_stop_device(sdkp, 1);
3603 if (!ret)
3604 opal_unlock_from_suspend(sdkp->opal_dev);
3605 return ret;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003606}
3607
Linus Torvalds1da177e2005-04-16 15:20:36 -07003608/**
3609 * init_sd - entry point for this driver (both when built in or when
3610 * a module).
3611 *
3612 * Note: this function registers this driver with the scsi mid-level.
3613 **/
3614static int __init init_sd(void)
3615{
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003616 int majors = 0, i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003617
3618 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3619
Hannes Reinecke0761df92013-05-10 11:06:16 +02003620 for (i = 0; i < SD_MAJORS; i++) {
3621 if (register_blkdev(sd_major(i), "sd") != 0)
3622 continue;
3623 majors++;
3624 blk_register_region(sd_major(i), SD_MINORS, NULL,
3625 sd_default_probe, NULL, NULL);
3626 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003627
3628 if (!majors)
3629 return -ENODEV;
3630
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003631 err = class_register(&sd_disk_class);
3632 if (err)
3633 goto err_out;
James Bottomley6bdaa1f2006-03-18 14:14:21 -06003634
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003635 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3636 0, 0, NULL);
3637 if (!sd_cdb_cache) {
3638 printk(KERN_ERR "sd: can't init extended cdb cache\n");
Clément Calmels8d964472014-06-03 23:34:25 +02003639 err = -ENOMEM;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003640 goto err_out_class;
3641 }
3642
3643 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3644 if (!sd_cdb_pool) {
3645 printk(KERN_ERR "sd: can't init extended cdb pool\n");
Clément Calmels8d964472014-06-03 23:34:25 +02003646 err = -ENOMEM;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003647 goto err_out_cache;
3648 }
3649
Jens Axboe61cce6f2018-12-12 06:46:55 -07003650 sd_page_pool = mempool_create_page_pool(SD_MEMPOOL_SIZE, 0);
3651 if (!sd_page_pool) {
3652 printk(KERN_ERR "sd: can't init discard page pool\n");
3653 err = -ENOMEM;
3654 goto err_out_ppool;
3655 }
3656
Joel D. Diazafd5e342012-10-10 10:36:11 +02003657 err = scsi_register_driver(&sd_template.gendrv);
3658 if (err)
3659 goto err_out_driver;
3660
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003661 return 0;
3662
Joel D. Diazafd5e342012-10-10 10:36:11 +02003663err_out_driver:
Jens Axboe61cce6f2018-12-12 06:46:55 -07003664 mempool_destroy(sd_page_pool);
3665
3666err_out_ppool:
Joel D. Diazafd5e342012-10-10 10:36:11 +02003667 mempool_destroy(sd_cdb_pool);
3668
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003669err_out_cache:
3670 kmem_cache_destroy(sd_cdb_cache);
3671
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003672err_out_class:
3673 class_unregister(&sd_disk_class);
3674err_out:
3675 for (i = 0; i < SD_MAJORS; i++)
3676 unregister_blkdev(sd_major(i), "sd");
3677 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003678}
3679
3680/**
3681 * exit_sd - exit point for this driver (when it is a module).
3682 *
3683 * Note: this function unregisters this driver from the scsi mid-level.
3684 **/
3685static void __exit exit_sd(void)
3686{
3687 int i;
3688
3689 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3690
Joel D. Diazafd5e342012-10-10 10:36:11 +02003691 scsi_unregister_driver(&sd_template.gendrv);
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003692 mempool_destroy(sd_cdb_pool);
Jens Axboe61cce6f2018-12-12 06:46:55 -07003693 mempool_destroy(sd_page_pool);
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003694 kmem_cache_destroy(sd_cdb_cache);
3695
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003696 class_unregister(&sd_disk_class);
3697
Hannes Reinecke0761df92013-05-10 11:06:16 +02003698 for (i = 0; i < SD_MAJORS; i++) {
3699 blk_unregister_region(sd_major(i), SD_MINORS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003700 unregister_blkdev(sd_major(i), "sd");
Hannes Reinecke0761df92013-05-10 11:06:16 +02003701 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003702}
3703
Linus Torvalds1da177e2005-04-16 15:20:36 -07003704module_init(init_sd);
3705module_exit(exit_sd);
Martin K. Petersene73aec82007-02-27 22:40:55 -05003706
3707static void sd_print_sense_hdr(struct scsi_disk *sdkp,
3708 struct scsi_sense_hdr *sshdr)
3709{
Hannes Reinecke21045512015-01-08 07:43:46 +01003710 scsi_print_sense_hdr(sdkp->device,
3711 sdkp->disk ? sdkp->disk->disk_name : NULL, sshdr);
Martin K. Petersene73aec82007-02-27 22:40:55 -05003712}
3713
Hannes Reineckeef613292014-10-24 14:27:00 +02003714static void sd_print_result(const struct scsi_disk *sdkp, const char *msg,
3715 int result)
Martin K. Petersene73aec82007-02-27 22:40:55 -05003716{
Hannes Reineckeef613292014-10-24 14:27:00 +02003717 const char *hb_string = scsi_hostbyte_string(result);
3718 const char *db_string = scsi_driverbyte_string(result);
3719
3720 if (hb_string || db_string)
3721 sd_printk(KERN_INFO, sdkp,
3722 "%s: Result: hostbyte=%s driverbyte=%s\n", msg,
3723 hb_string ? hb_string : "invalid",
3724 db_string ? db_string : "invalid");
3725 else
3726 sd_printk(KERN_INFO, sdkp,
3727 "%s: Result: hostbyte=0x%02x driverbyte=0x%02x\n",
3728 msg, host_byte(result), driver_byte(result));
Martin K. Petersene73aec82007-02-27 22:40:55 -05003729}
3730