blob: b2da8a00ec3357af6fd5460bb45016eafe8e389d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * sd.c Copyright (C) 1992 Drew Eckhardt
3 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
4 *
5 * Linux scsi disk driver
6 * Initial versions: Drew Eckhardt
7 * Subsequent revisions: Eric Youngdale
8 * Modification history:
9 * - Drew Eckhardt <drew@colorado.edu> original
10 * - Eric Youngdale <eric@andante.org> add scatter-gather, multiple
11 * outstanding request, and other enhancements.
12 * Support loadable low-level scsi drivers.
13 * - Jirka Hanika <geo@ff.cuni.cz> support more scsi disks using
14 * eight major numbers.
15 * - Richard Gooch <rgooch@atnf.csiro.au> support devfs.
16 * - Torben Mathiasen <tmm@image.dk> Resource allocation fixes in
17 * sd_init and cleanups.
18 * - Alex Davis <letmein@erols.com> Fix problem where partition info
19 * not being read in sd_open. Fix problem where removable media
20 * could be ejected after sd_open.
21 * - Douglas Gilbert <dgilbert@interlog.com> cleanup for lk 2.5.x
22 * - Badari Pulavarty <pbadari@us.ibm.com>, Matthew Wilcox
23 * <willy@debian.org>, Kurt Garloff <garloff@suse.de>:
24 * Support 32k/1M disks.
25 *
26 * Logging policy (needs CONFIG_SCSI_LOGGING defined):
27 * - setting up transfer: SCSI_LOG_HLQUEUE levels 1 and 2
28 * - end of transfer (bh + scsi_lib): SCSI_LOG_HLCOMPLETE level 1
29 * - entering sd_ioctl: SCSI_LOG_IOCTL level 1
30 * - entering other commands: SCSI_LOG_HLQUEUE level 3
31 * Note: when the logging level is set by the user, it must be greater
32 * than the level indicated above to trigger output.
33 */
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/module.h>
36#include <linux/fs.h>
37#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/mm.h>
39#include <linux/bio.h>
40#include <linux/genhd.h>
41#include <linux/hdreg.h>
42#include <linux/errno.h>
43#include <linux/idr.h>
44#include <linux/interrupt.h>
45#include <linux/init.h>
46#include <linux/blkdev.h>
47#include <linux/blkpg.h>
Bart Van Asschebca6b062018-09-26 14:01:03 -070048#include <linux/blk-pm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#include <linux/delay.h>
Arjan van de Ven0b950672006-01-11 13:16:10 +010050#include <linux/mutex.h>
James Bottomley7404ad3b2008-08-31 10:41:52 -050051#include <linux/string_helpers.h>
Arjan van de Ven4ace92f2009-01-04 05:32:28 -080052#include <linux/async.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090053#include <linux/slab.h>
Christoph Hellwigd80210f2017-06-19 14:26:46 +020054#include <linux/sed-opal.h>
Lin Ming54f575882011-12-05 09:20:26 +080055#include <linux/pm_runtime.h>
Christoph Hellwig924d55b2015-10-15 14:10:49 +020056#include <linux/pr.h>
Christoph Hellwig8475c812016-09-11 19:35:41 +020057#include <linux/t10-pi.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080058#include <linux/uaccess.h>
Dave Hansen8f76d152009-04-21 16:43:27 -070059#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61#include <scsi/scsi.h>
62#include <scsi/scsi_cmnd.h>
63#include <scsi/scsi_dbg.h>
64#include <scsi/scsi_device.h>
65#include <scsi/scsi_driver.h>
66#include <scsi/scsi_eh.h>
67#include <scsi/scsi_host.h>
68#include <scsi/scsi_ioctl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <scsi/scsicam.h>
70
Martin K. Petersenaa916962008-06-17 12:47:32 -040071#include "sd.h"
Dan Williamsa7a20d12012-03-22 17:05:11 -070072#include "scsi_priv.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#include "scsi_logging.h"
74
Rene Hermanf018fa52006-03-08 00:14:20 -080075MODULE_AUTHOR("Eric Youngdale");
76MODULE_DESCRIPTION("SCSI disk (sd) driver");
77MODULE_LICENSE("GPL");
78
79MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
80MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
81MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
82MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
83MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
84MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
85MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
86MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
87MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
88MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
89MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
90MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
91MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
92MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
93MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
94MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
Michael Tokarevd7b8bcb02006-10-27 16:02:37 +040095MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
96MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
97MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
Hannes Reinecke89d94752016-10-18 15:40:34 +090098MODULE_ALIAS_SCSI_DEVICE(TYPE_ZBC);
Rene Hermanf018fa52006-03-08 00:14:20 -080099
Tejun Heo870d6652008-08-25 19:47:25 +0900100#if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
Tejun Heof615b482008-08-25 19:47:24 +0900101#define SD_MINORS 16
Tejun Heo870d6652008-08-25 19:47:25 +0900102#else
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900103#define SD_MINORS 0
Tejun Heo870d6652008-08-25 19:47:25 +0900104#endif
105
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500106static void sd_config_discard(struct scsi_disk *, unsigned int);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400107static void sd_config_write_same(struct scsi_disk *);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800108static int sd_revalidate_disk(struct gendisk *);
Tejun Heo72ec24b2010-05-15 20:09:32 +0200109static void sd_unlock_native_capacity(struct gendisk *disk);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800110static int sd_probe(struct device *);
111static int sd_remove(struct device *);
112static void sd_shutdown(struct device *);
Oliver Neukum95897912013-09-16 13:28:15 +0200113static int sd_suspend_system(struct device *);
114static int sd_suspend_runtime(struct device *);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800115static int sd_resume(struct device *);
116static void sd_rescan(struct device *);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100117static blk_status_t sd_init_command(struct scsi_cmnd *SCpnt);
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +0200118static void sd_uninit_command(struct scsi_cmnd *SCpnt);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800119static int sd_done(struct scsi_cmnd *);
Hannes Reinecke7a38dc0b2017-04-06 15:36:29 +0200120static void sd_eh_reset(struct scsi_cmnd *);
James Bottomley24510792013-11-11 13:44:53 +0100121static int sd_eh_action(struct scsi_cmnd *, int);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800122static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
Tony Jonesee959b02008-02-22 00:13:36 +0100123static void scsi_disk_release(struct device *cdev);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800124static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
Hannes Reineckeef613292014-10-24 14:27:00 +0200125static void sd_print_result(const struct scsi_disk *, const char *, int);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800126
Tejun Heof27bac22008-07-14 14:59:30 +0900127static DEFINE_IDA(sd_index_ida);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129/* This semaphore is used to mediate the 0->1 reference get in the
130 * face of object destruction (i.e. we can't allow a get on an
131 * object after last put) */
Arjan van de Ven0b950672006-01-11 13:16:10 +0100132static DEFINE_MUTEX(sd_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
H Hartley Sweeten439d77f2010-08-10 18:01:20 -0700134static struct kmem_cache *sd_cdb_cache;
135static mempool_t *sd_cdb_pool;
Jens Axboe61cce6f2018-12-12 06:46:55 -0700136static mempool_t *sd_page_pool;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -0400137
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600138static const char *sd_cache_types[] = {
139 "write through", "none", "write back",
140 "write back, no read (daft)"
141};
142
Vaughan Caocb2fb682014-06-03 17:37:30 +0800143static void sd_set_flush_flag(struct scsi_disk *sdkp)
144{
Jens Axboeeb310e22016-03-30 10:06:11 -0600145 bool wc = false, fua = false;
Vaughan Caocb2fb682014-06-03 17:37:30 +0800146
147 if (sdkp->WCE) {
Jens Axboeeb310e22016-03-30 10:06:11 -0600148 wc = true;
Vaughan Caocb2fb682014-06-03 17:37:30 +0800149 if (sdkp->DPOFUA)
Jens Axboeeb310e22016-03-30 10:06:11 -0600150 fua = true;
Vaughan Caocb2fb682014-06-03 17:37:30 +0800151 }
152
Jens Axboeeb310e22016-03-30 10:06:11 -0600153 blk_queue_write_cache(sdkp->disk->queue, wc, fua);
Vaughan Caocb2fb682014-06-03 17:37:30 +0800154}
155
Tony Jonesee959b02008-02-22 00:13:36 +0100156static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700157cache_type_store(struct device *dev, struct device_attribute *attr,
158 const char *buf, size_t count)
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600159{
Martin K. Petersen4c117122017-05-25 09:34:30 -0400160 int ct, rcd, wce, sp;
Tony Jonesee959b02008-02-22 00:13:36 +0100161 struct scsi_disk *sdkp = to_scsi_disk(dev);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600162 struct scsi_device *sdp = sdkp->device;
163 char buffer[64];
164 char *buffer_data;
165 struct scsi_mode_data data;
166 struct scsi_sense_hdr sshdr;
Ben Hutchings2ee3e262013-05-27 19:07:19 +0100167 static const char temp[] = "temporary ";
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600168 int len;
169
Hannes Reinecke89d94752016-10-18 15:40:34 +0900170 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600171 /* no cache control on RBC devices; theoretically they
172 * can do it, but there's probably so many exceptions
173 * it's not worth the risk */
174 return -EINVAL;
175
James Bottomley39c60a02013-04-24 14:02:53 -0700176 if (strncmp(buf, temp, sizeof(temp) - 1) == 0) {
177 buf += sizeof(temp) - 1;
178 sdkp->cache_override = 1;
179 } else {
180 sdkp->cache_override = 0;
181 }
182
Martin K. Petersen4c117122017-05-25 09:34:30 -0400183 ct = sysfs_match_string(sd_cache_types, buf);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600184 if (ct < 0)
185 return -EINVAL;
Martin K. Petersen4c117122017-05-25 09:34:30 -0400186
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600187 rcd = ct & 0x01 ? 1 : 0;
Sujit Reddy Thumma2eefd572014-08-11 15:40:37 +0300188 wce = (ct & 0x02) && !sdkp->write_prot ? 1 : 0;
James Bottomley39c60a02013-04-24 14:02:53 -0700189
190 if (sdkp->cache_override) {
191 sdkp->WCE = wce;
192 sdkp->RCD = rcd;
Vaughan Caocb2fb682014-06-03 17:37:30 +0800193 sd_set_flush_flag(sdkp);
James Bottomley39c60a02013-04-24 14:02:53 -0700194 return count;
195 }
196
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600197 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
198 SD_MAX_RETRIES, &data, NULL))
199 return -EINVAL;
Andrew Mortona9312fb2006-03-25 03:08:30 -0800200 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600201 data.block_descriptor_length);
202 buffer_data = buffer + data.header_length +
203 data.block_descriptor_length;
204 buffer_data[2] &= ~0x05;
205 buffer_data[2] |= wce << 2 | rcd;
206 sp = buffer_data[0] & 0x80 ? 1 : 0;
Gabriel Krisman Bertazi2c5d16d2015-10-30 16:04:43 -0200207 buffer_data[0] &= ~0x80;
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600208
Ivan Mironov44759972018-12-23 12:41:58 +0500209 /*
210 * Ensure WP, DPOFUA, and RESERVED fields are cleared in
211 * received mode parameter buffer before doing MODE SELECT.
212 */
213 data.device_specific = 0;
214
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600215 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
216 SD_MAX_RETRIES, &data, &sshdr)) {
217 if (scsi_sense_valid(&sshdr))
Martin K. Petersene73aec82007-02-27 22:40:55 -0500218 sd_print_sense_hdr(sdkp, &sshdr);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600219 return -EINVAL;
220 }
Andrew Pattersonf98a8ca2008-09-04 14:27:35 -0600221 revalidate_disk(sdkp->disk);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600222 return count;
223}
224
Tony Jonesee959b02008-02-22 00:13:36 +0100225static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700226manage_start_stop_show(struct device *dev, struct device_attribute *attr,
227 char *buf)
228{
229 struct scsi_disk *sdkp = to_scsi_disk(dev);
230 struct scsi_device *sdp = sdkp->device;
231
Martin K. Petersen4c117122017-05-25 09:34:30 -0400232 return sprintf(buf, "%u\n", sdp->manage_start_stop);
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700233}
234
235static ssize_t
236manage_start_stop_store(struct device *dev, struct device_attribute *attr,
237 const char *buf, size_t count)
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900238{
Tony Jonesee959b02008-02-22 00:13:36 +0100239 struct scsi_disk *sdkp = to_scsi_disk(dev);
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900240 struct scsi_device *sdp = sdkp->device;
weiping zhang623401e2017-10-12 14:57:06 +0800241 bool v;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900242
243 if (!capable(CAP_SYS_ADMIN))
244 return -EACCES;
245
weiping zhang623401e2017-10-12 14:57:06 +0800246 if (kstrtobool(buf, &v))
247 return -EINVAL;
248
249 sdp->manage_start_stop = v;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900250
251 return count;
252}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700253static DEVICE_ATTR_RW(manage_start_stop);
Tejun Heoc3c94c5a2007-03-21 00:13:59 +0900254
Tony Jonesee959b02008-02-22 00:13:36 +0100255static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700256allow_restart_show(struct device *dev, struct device_attribute *attr, char *buf)
257{
258 struct scsi_disk *sdkp = to_scsi_disk(dev);
259
Martin K. Petersen4c117122017-05-25 09:34:30 -0400260 return sprintf(buf, "%u\n", sdkp->device->allow_restart);
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700261}
262
263static ssize_t
264allow_restart_store(struct device *dev, struct device_attribute *attr,
265 const char *buf, size_t count)
Brian Kinga144c5a2006-06-27 11:10:31 -0500266{
weiping zhang658e9a62017-10-12 14:56:44 +0800267 bool v;
Tony Jonesee959b02008-02-22 00:13:36 +0100268 struct scsi_disk *sdkp = to_scsi_disk(dev);
Brian Kinga144c5a2006-06-27 11:10:31 -0500269 struct scsi_device *sdp = sdkp->device;
270
271 if (!capable(CAP_SYS_ADMIN))
272 return -EACCES;
273
Hannes Reinecke89d94752016-10-18 15:40:34 +0900274 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
Brian Kinga144c5a2006-06-27 11:10:31 -0500275 return -EINVAL;
276
weiping zhang658e9a62017-10-12 14:56:44 +0800277 if (kstrtobool(buf, &v))
278 return -EINVAL;
279
280 sdp->allow_restart = v;
Brian Kinga144c5a2006-06-27 11:10:31 -0500281
282 return count;
283}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700284static DEVICE_ATTR_RW(allow_restart);
Brian Kinga144c5a2006-06-27 11:10:31 -0500285
Tony Jonesee959b02008-02-22 00:13:36 +0100286static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700287cache_type_show(struct device *dev, struct device_attribute *attr, char *buf)
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600288{
Tony Jonesee959b02008-02-22 00:13:36 +0100289 struct scsi_disk *sdkp = to_scsi_disk(dev);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600290 int ct = sdkp->RCD + 2*sdkp->WCE;
291
Martin K. Petersen4c117122017-05-25 09:34:30 -0400292 return sprintf(buf, "%s\n", sd_cache_types[ct]);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600293}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700294static DEVICE_ATTR_RW(cache_type);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600295
Tony Jonesee959b02008-02-22 00:13:36 +0100296static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700297FUA_show(struct device *dev, struct device_attribute *attr, char *buf)
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600298{
Tony Jonesee959b02008-02-22 00:13:36 +0100299 struct scsi_disk *sdkp = to_scsi_disk(dev);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600300
Martin K. Petersen4c117122017-05-25 09:34:30 -0400301 return sprintf(buf, "%u\n", sdkp->DPOFUA);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600302}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700303static DEVICE_ATTR_RO(FUA);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600304
Tony Jonesee959b02008-02-22 00:13:36 +0100305static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700306protection_type_show(struct device *dev, struct device_attribute *attr,
307 char *buf)
Martin K. Petersene0597d72008-07-17 04:28:34 -0400308{
309 struct scsi_disk *sdkp = to_scsi_disk(dev);
310
Martin K. Petersen4c117122017-05-25 09:34:30 -0400311 return sprintf(buf, "%u\n", sdkp->protection_type);
Martin K. Petersene0597d72008-07-17 04:28:34 -0400312}
313
314static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700315protection_type_store(struct device *dev, struct device_attribute *attr,
316 const char *buf, size_t count)
Martin K. Petersen81724992012-08-28 14:29:34 -0400317{
318 struct scsi_disk *sdkp = to_scsi_disk(dev);
319 unsigned int val;
320 int err;
321
322 if (!capable(CAP_SYS_ADMIN))
323 return -EACCES;
324
325 err = kstrtouint(buf, 10, &val);
326
327 if (err)
328 return err;
329
Bart Van Assche830cc352017-08-25 13:46:35 -0700330 if (val <= T10_PI_TYPE3_PROTECTION)
Martin K. Petersen81724992012-08-28 14:29:34 -0400331 sdkp->protection_type = val;
332
333 return count;
334}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700335static DEVICE_ATTR_RW(protection_type);
Martin K. Petersen81724992012-08-28 14:29:34 -0400336
337static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700338protection_mode_show(struct device *dev, struct device_attribute *attr,
339 char *buf)
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400340{
341 struct scsi_disk *sdkp = to_scsi_disk(dev);
342 struct scsi_device *sdp = sdkp->device;
343 unsigned int dif, dix;
344
345 dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
346 dix = scsi_host_dix_capable(sdp->host, sdkp->protection_type);
347
Christoph Hellwig8475c812016-09-11 19:35:41 +0200348 if (!dix && scsi_host_dix_capable(sdp->host, T10_PI_TYPE0_PROTECTION)) {
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400349 dif = 0;
350 dix = 1;
351 }
352
353 if (!dif && !dix)
Martin K. Petersen4c117122017-05-25 09:34:30 -0400354 return sprintf(buf, "none\n");
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400355
Martin K. Petersen4c117122017-05-25 09:34:30 -0400356 return sprintf(buf, "%s%u\n", dix ? "dix" : "dif", dif);
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400357}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700358static DEVICE_ATTR_RO(protection_mode);
Martin K. Petersen518fa8e2010-10-08 01:36:24 -0400359
360static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700361app_tag_own_show(struct device *dev, struct device_attribute *attr, char *buf)
Martin K. Petersene0597d72008-07-17 04:28:34 -0400362{
363 struct scsi_disk *sdkp = to_scsi_disk(dev);
364
Martin K. Petersen4c117122017-05-25 09:34:30 -0400365 return sprintf(buf, "%u\n", sdkp->ATO);
Martin K. Petersene0597d72008-07-17 04:28:34 -0400366}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700367static DEVICE_ATTR_RO(app_tag_own);
Martin K. Petersene0597d72008-07-17 04:28:34 -0400368
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500369static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700370thin_provisioning_show(struct device *dev, struct device_attribute *attr,
371 char *buf)
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500372{
373 struct scsi_disk *sdkp = to_scsi_disk(dev);
374
Martin K. Petersen4c117122017-05-25 09:34:30 -0400375 return sprintf(buf, "%u\n", sdkp->lbpme);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500376}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700377static DEVICE_ATTR_RO(thin_provisioning);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500378
Martin K. Petersen4c117122017-05-25 09:34:30 -0400379/* sysfs_match_string() requires dense arrays */
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500380static const char *lbp_mode[] = {
381 [SD_LBP_FULL] = "full",
382 [SD_LBP_UNMAP] = "unmap",
383 [SD_LBP_WS16] = "writesame_16",
384 [SD_LBP_WS10] = "writesame_10",
385 [SD_LBP_ZERO] = "writesame_zero",
386 [SD_LBP_DISABLE] = "disabled",
387};
388
389static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700390provisioning_mode_show(struct device *dev, struct device_attribute *attr,
391 char *buf)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500392{
393 struct scsi_disk *sdkp = to_scsi_disk(dev);
394
Martin K. Petersen4c117122017-05-25 09:34:30 -0400395 return sprintf(buf, "%s\n", lbp_mode[sdkp->provisioning_mode]);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500396}
397
398static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700399provisioning_mode_store(struct device *dev, struct device_attribute *attr,
400 const char *buf, size_t count)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500401{
402 struct scsi_disk *sdkp = to_scsi_disk(dev);
403 struct scsi_device *sdp = sdkp->device;
Martin K. Petersen4c117122017-05-25 09:34:30 -0400404 int mode;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500405
406 if (!capable(CAP_SYS_ADMIN))
407 return -EACCES;
408
Hannes Reinecke89d94752016-10-18 15:40:34 +0900409 if (sd_is_zoned(sdkp)) {
410 sd_config_discard(sdkp, SD_LBP_DISABLE);
411 return count;
412 }
413
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500414 if (sdp->type != TYPE_DISK)
415 return -EINVAL;
416
Martin K. Petersen4c117122017-05-25 09:34:30 -0400417 mode = sysfs_match_string(lbp_mode, buf);
418 if (mode < 0)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500419 return -EINVAL;
420
Martin K. Petersen4c117122017-05-25 09:34:30 -0400421 sd_config_discard(sdkp, mode);
422
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500423 return count;
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500424}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700425static DEVICE_ATTR_RW(provisioning_mode);
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500426
Martin K. Petersen4c117122017-05-25 09:34:30 -0400427/* sysfs_match_string() requires dense arrays */
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200428static const char *zeroing_mode[] = {
429 [SD_ZERO_WRITE] = "write",
430 [SD_ZERO_WS] = "writesame",
431 [SD_ZERO_WS16_UNMAP] = "writesame_16_unmap",
432 [SD_ZERO_WS10_UNMAP] = "writesame_10_unmap",
433};
434
435static ssize_t
436zeroing_mode_show(struct device *dev, struct device_attribute *attr,
437 char *buf)
438{
439 struct scsi_disk *sdkp = to_scsi_disk(dev);
440
Martin K. Petersen4c117122017-05-25 09:34:30 -0400441 return sprintf(buf, "%s\n", zeroing_mode[sdkp->zeroing_mode]);
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200442}
443
444static ssize_t
445zeroing_mode_store(struct device *dev, struct device_attribute *attr,
446 const char *buf, size_t count)
447{
448 struct scsi_disk *sdkp = to_scsi_disk(dev);
Martin K. Petersen4c117122017-05-25 09:34:30 -0400449 int mode;
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200450
451 if (!capable(CAP_SYS_ADMIN))
452 return -EACCES;
453
Martin K. Petersen4c117122017-05-25 09:34:30 -0400454 mode = sysfs_match_string(zeroing_mode, buf);
455 if (mode < 0)
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200456 return -EINVAL;
457
Martin K. Petersen4c117122017-05-25 09:34:30 -0400458 sdkp->zeroing_mode = mode;
459
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200460 return count;
461}
462static DEVICE_ATTR_RW(zeroing_mode);
463
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500464static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700465max_medium_access_timeouts_show(struct device *dev,
466 struct device_attribute *attr, char *buf)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500467{
468 struct scsi_disk *sdkp = to_scsi_disk(dev);
469
Martin K. Petersen4c117122017-05-25 09:34:30 -0400470 return sprintf(buf, "%u\n", sdkp->max_medium_access_timeouts);
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500471}
472
473static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700474max_medium_access_timeouts_store(struct device *dev,
475 struct device_attribute *attr, const char *buf,
476 size_t count)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500477{
478 struct scsi_disk *sdkp = to_scsi_disk(dev);
479 int err;
480
481 if (!capable(CAP_SYS_ADMIN))
482 return -EACCES;
483
484 err = kstrtouint(buf, 10, &sdkp->max_medium_access_timeouts);
485
486 return err ? err : count;
487}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700488static DEVICE_ATTR_RW(max_medium_access_timeouts);
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500489
Martin K. Petersen5db44862012-09-18 12:19:32 -0400490static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700491max_write_same_blocks_show(struct device *dev, struct device_attribute *attr,
492 char *buf)
Martin K. Petersen5db44862012-09-18 12:19:32 -0400493{
494 struct scsi_disk *sdkp = to_scsi_disk(dev);
495
Martin K. Petersen4c117122017-05-25 09:34:30 -0400496 return sprintf(buf, "%u\n", sdkp->max_ws_blocks);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400497}
498
499static ssize_t
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700500max_write_same_blocks_store(struct device *dev, struct device_attribute *attr,
501 const char *buf, size_t count)
Martin K. Petersen5db44862012-09-18 12:19:32 -0400502{
503 struct scsi_disk *sdkp = to_scsi_disk(dev);
504 struct scsi_device *sdp = sdkp->device;
505 unsigned long max;
506 int err;
507
508 if (!capable(CAP_SYS_ADMIN))
509 return -EACCES;
510
Hannes Reinecke89d94752016-10-18 15:40:34 +0900511 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
Martin K. Petersen5db44862012-09-18 12:19:32 -0400512 return -EINVAL;
513
514 err = kstrtoul(buf, 10, &max);
515
516 if (err)
517 return err;
518
519 if (max == 0)
520 sdp->no_write_same = 1;
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400521 else if (max <= SD_MAX_WS16_BLOCKS) {
522 sdp->no_write_same = 0;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400523 sdkp->max_ws_blocks = max;
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400524 }
Martin K. Petersen5db44862012-09-18 12:19:32 -0400525
526 sd_config_write_same(sdkp);
527
528 return count;
529}
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700530static DEVICE_ATTR_RW(max_write_same_blocks);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400531
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700532static struct attribute *sd_disk_attrs[] = {
533 &dev_attr_cache_type.attr,
534 &dev_attr_FUA.attr,
535 &dev_attr_allow_restart.attr,
536 &dev_attr_manage_start_stop.attr,
537 &dev_attr_protection_type.attr,
538 &dev_attr_protection_mode.attr,
539 &dev_attr_app_tag_own.attr,
540 &dev_attr_thin_provisioning.attr,
541 &dev_attr_provisioning_mode.attr,
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200542 &dev_attr_zeroing_mode.attr,
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700543 &dev_attr_max_write_same_blocks.attr,
544 &dev_attr_max_medium_access_timeouts.attr,
545 NULL,
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600546};
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700547ATTRIBUTE_GROUPS(sd_disk);
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600548
549static struct class sd_disk_class = {
550 .name = "scsi_disk",
551 .owner = THIS_MODULE,
Tony Jonesee959b02008-02-22 00:13:36 +0100552 .dev_release = scsi_disk_release,
Greg Kroah-Hartmane1ea2352013-07-24 15:05:28 -0700553 .dev_groups = sd_disk_groups,
James Bottomley6bdaa1f2006-03-18 14:14:21 -0600554};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
Aaron Lu691e3d32012-11-09 15:27:55 +0800556static const struct dev_pm_ops sd_pm_ops = {
Oliver Neukum95897912013-09-16 13:28:15 +0200557 .suspend = sd_suspend_system,
Aaron Lu691e3d32012-11-09 15:27:55 +0800558 .resume = sd_resume,
Oliver Neukum95897912013-09-16 13:28:15 +0200559 .poweroff = sd_suspend_system,
Aaron Lu691e3d32012-11-09 15:27:55 +0800560 .restore = sd_resume,
Oliver Neukum95897912013-09-16 13:28:15 +0200561 .runtime_suspend = sd_suspend_runtime,
Aaron Lu691e3d32012-11-09 15:27:55 +0800562 .runtime_resume = sd_resume,
563};
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565static struct scsi_driver sd_template = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 .gendrv = {
567 .name = "sd",
Christoph Hellwig3af6b352014-11-12 18:34:51 +0100568 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 .probe = sd_probe,
570 .remove = sd_remove,
571 .shutdown = sd_shutdown,
Aaron Lu691e3d32012-11-09 15:27:55 +0800572 .pm = &sd_pm_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 },
574 .rescan = sd_rescan,
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +0200575 .init_command = sd_init_command,
576 .uninit_command = sd_uninit_command,
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800577 .done = sd_done,
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500578 .eh_action = sd_eh_action,
Hannes Reinecke7a38dc0b2017-04-06 15:36:29 +0200579 .eh_reset = sd_eh_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580};
581
582/*
Hannes Reinecke0761df92013-05-10 11:06:16 +0200583 * Dummy kobj_map->probe function.
584 * The default ->probe function will call modprobe, which is
585 * pointless as this module is already loaded.
586 */
587static struct kobject *sd_default_probe(dev_t devt, int *partno, void *data)
588{
589 return NULL;
590}
591
592/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 * Device no to disk mapping:
594 *
595 * major disc2 disc p1
596 * |............|.............|....|....| <- dev_t
597 * 31 20 19 8 7 4 3 0
598 *
599 * Inside a major, we have 16k disks, however mapped non-
600 * contiguously. The first 16 disks are for major0, the next
601 * ones with major1, ... Disk 256 is for major0 again, disk 272
602 * for major1, ...
603 * As we stay compatible with our numbering scheme, we can reuse
604 * the well-know SCSI majors 8, 65--71, 136--143.
605 */
606static int sd_major(int major_idx)
607{
608 switch (major_idx) {
609 case 0:
610 return SCSI_DISK0_MAJOR;
611 case 1 ... 7:
612 return SCSI_DISK1_MAJOR + major_idx - 1;
613 case 8 ... 15:
614 return SCSI_DISK8_MAJOR + major_idx - 8;
615 default:
616 BUG();
617 return 0; /* shut up gcc */
618 }
619}
620
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +0100621static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622{
623 struct scsi_disk *sdkp = NULL;
624
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +0100625 mutex_lock(&sd_ref_mutex);
626
Alan Stern39b7f1e2005-11-04 14:44:41 -0500627 if (disk->private_data) {
628 sdkp = scsi_disk(disk);
629 if (scsi_device_get(sdkp->device) == 0)
Tony Jonesee959b02008-02-22 00:13:36 +0100630 get_device(&sdkp->dev);
Alan Stern39b7f1e2005-11-04 14:44:41 -0500631 else
632 sdkp = NULL;
633 }
Arjan van de Ven0b950672006-01-11 13:16:10 +0100634 mutex_unlock(&sd_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 return sdkp;
636}
637
638static void scsi_disk_put(struct scsi_disk *sdkp)
639{
640 struct scsi_device *sdev = sdkp->device;
641
Arjan van de Ven0b950672006-01-11 13:16:10 +0100642 mutex_lock(&sd_ref_mutex);
Tony Jonesee959b02008-02-22 00:13:36 +0100643 put_device(&sdkp->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 scsi_device_put(sdev);
Arjan van de Ven0b950672006-01-11 13:16:10 +0100645 mutex_unlock(&sd_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646}
647
Christoph Hellwigd80210f2017-06-19 14:26:46 +0200648#ifdef CONFIG_BLK_SED_OPAL
649static int sd_sec_submit(void *data, u16 spsp, u8 secp, void *buffer,
650 size_t len, bool send)
651{
652 struct scsi_device *sdev = data;
653 u8 cdb[12] = { 0, };
654 int ret;
655
656 cdb[0] = send ? SECURITY_PROTOCOL_OUT : SECURITY_PROTOCOL_IN;
657 cdb[1] = secp;
658 put_unaligned_be16(spsp, &cdb[2]);
659 put_unaligned_be32(len, &cdb[6]);
660
661 ret = scsi_execute_req(sdev, cdb,
662 send ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
663 buffer, len, NULL, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
664 return ret <= 0 ? ret : -EIO;
665}
666#endif /* CONFIG_BLK_SED_OPAL */
667
Martin K. Petersenc6115292014-09-26 19:20:08 -0400668static unsigned char sd_setup_protect_cmnd(struct scsi_cmnd *scmd,
669 unsigned int dix, unsigned int dif)
670{
671 struct bio *bio = scmd->request->bio;
672 unsigned int prot_op = sd_prot_op(rq_data_dir(scmd->request), dix, dif);
673 unsigned int protect = 0;
674
675 if (dix) { /* DIX Type 0, 1, 2, 3 */
676 if (bio_integrity_flagged(bio, BIP_IP_CHECKSUM))
677 scmd->prot_flags |= SCSI_PROT_IP_CHECKSUM;
678
679 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
680 scmd->prot_flags |= SCSI_PROT_GUARD_CHECK;
681 }
682
Christoph Hellwig8475c812016-09-11 19:35:41 +0200683 if (dif != T10_PI_TYPE3_PROTECTION) { /* DIX/DIF Type 0, 1, 2 */
Martin K. Petersenc6115292014-09-26 19:20:08 -0400684 scmd->prot_flags |= SCSI_PROT_REF_INCREMENT;
685
686 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
687 scmd->prot_flags |= SCSI_PROT_REF_CHECK;
688 }
689
690 if (dif) { /* DIX/DIF Type 1, 2, 3 */
691 scmd->prot_flags |= SCSI_PROT_TRANSFER_PI;
692
693 if (bio_integrity_flagged(bio, BIP_DISK_NOCHECK))
694 protect = 3 << 5; /* Disable target PI checking */
695 else
696 protect = 1 << 5; /* Enable target PI checking */
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400697 }
698
699 scsi_set_prot_op(scmd, prot_op);
700 scsi_set_prot_type(scmd, dif);
Martin K. Petersenc6115292014-09-26 19:20:08 -0400701 scmd->prot_flags &= sd_prot_flag_mask(prot_op);
702
703 return protect;
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400704}
705
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500706static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
707{
708 struct request_queue *q = sdkp->disk->queue;
709 unsigned int logical_block_size = sdkp->device->sector_size;
710 unsigned int max_blocks = 0;
711
Martin K. Petersenbcd069b2017-04-05 19:21:25 +0200712 q->limits.discard_alignment =
713 sdkp->unmap_alignment * logical_block_size;
714 q->limits.discard_granularity =
715 max(sdkp->physical_block_size,
716 sdkp->unmap_granularity * logical_block_size);
Martin K. Petersen89730392012-02-13 15:39:00 -0500717 sdkp->provisioning_mode = mode;
718
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500719 switch (mode) {
720
Martin K. Petersen4c117122017-05-25 09:34:30 -0400721 case SD_LBP_FULL:
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500722 case SD_LBP_DISABLE:
Jens Axboe2bb4cd52015-07-14 08:15:12 -0600723 blk_queue_max_discard_sectors(q, 0);
Bart Van Assche8b904b52018-03-07 17:10:10 -0800724 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500725 return;
726
727 case SD_LBP_UNMAP:
Martin K. Petersen5db44862012-09-18 12:19:32 -0400728 max_blocks = min_not_zero(sdkp->max_unmap_blocks,
729 (u32)SD_MAX_WS16_BLOCKS);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500730 break;
731
732 case SD_LBP_WS16:
Martin K. Petersen28a0bc42017-09-27 21:35:12 -0400733 if (sdkp->device->unmap_limit_for_ws)
734 max_blocks = sdkp->max_unmap_blocks;
735 else
736 max_blocks = sdkp->max_ws_blocks;
737
738 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS16_BLOCKS);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500739 break;
740
741 case SD_LBP_WS10:
Martin K. Petersen28a0bc42017-09-27 21:35:12 -0400742 if (sdkp->device->unmap_limit_for_ws)
743 max_blocks = sdkp->max_unmap_blocks;
744 else
745 max_blocks = sdkp->max_ws_blocks;
746
747 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS10_BLOCKS);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500748 break;
749
750 case SD_LBP_ZERO:
Martin K. Petersen5db44862012-09-18 12:19:32 -0400751 max_blocks = min_not_zero(sdkp->max_ws_blocks,
752 (u32)SD_MAX_WS10_BLOCKS);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500753 break;
754 }
755
Jens Axboe2bb4cd52015-07-14 08:15:12 -0600756 blk_queue_max_discard_sectors(q, max_blocks * (logical_block_size >> 9));
Bart Van Assche8b904b52018-03-07 17:10:10 -0800757 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500758}
759
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100760static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500761{
Christoph Hellwig6a7b4392014-06-28 12:35:13 +0200762 struct scsi_device *sdp = cmd->device;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200763 struct request *rq = cmd->request;
764 u64 sector = blk_rq_pos(rq) >> (ilog2(sdp->sector_size) - 9);
765 u32 nr_sectors = blk_rq_sectors(rq) >> (ilog2(sdp->sector_size) - 9);
766 unsigned int data_len = 24;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500767 char *buf;
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500768
Jens Axboe61cce6f2018-12-12 06:46:55 -0700769 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200770 if (!rq->special_vec.bv_page)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100771 return BLK_STS_RESOURCE;
Jens Axboe61cce6f2018-12-12 06:46:55 -0700772 clear_highpage(rq->special_vec.bv_page);
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700773 rq->special_vec.bv_offset = 0;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200774 rq->special_vec.bv_len = data_len;
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700775 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
Christoph Hellwigf9d03f92016-12-08 15:20:32 -0700776
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200777 cmd->cmd_len = 10;
778 cmd->cmnd[0] = UNMAP;
779 cmd->cmnd[8] = 24;
780
781 buf = page_address(rq->special_vec.bv_page);
782 put_unaligned_be16(6 + 16, &buf[0]);
783 put_unaligned_be16(16, &buf[2]);
784 put_unaligned_be64(sector, &buf[8]);
785 put_unaligned_be32(nr_sectors, &buf[16]);
786
787 cmd->allowed = SD_MAX_RETRIES;
788 cmd->transfersize = data_len;
789 rq->timeout = SD_TIMEOUT;
790 scsi_req(rq)->resid_len = data_len;
791
792 return scsi_init_io(cmd);
793}
794
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100795static blk_status_t sd_setup_write_same16_cmnd(struct scsi_cmnd *cmd,
796 bool unmap)
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200797{
798 struct scsi_device *sdp = cmd->device;
799 struct request *rq = cmd->request;
800 u64 sector = blk_rq_pos(rq) >> (ilog2(sdp->sector_size) - 9);
801 u32 nr_sectors = blk_rq_sectors(rq) >> (ilog2(sdp->sector_size) - 9);
802 u32 data_len = sdp->sector_size;
803
Jens Axboe61cce6f2018-12-12 06:46:55 -0700804 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200805 if (!rq->special_vec.bv_page)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100806 return BLK_STS_RESOURCE;
Jens Axboe61cce6f2018-12-12 06:46:55 -0700807 clear_highpage(rq->special_vec.bv_page);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200808 rq->special_vec.bv_offset = 0;
809 rq->special_vec.bv_len = data_len;
810 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
811
812 cmd->cmd_len = 16;
813 cmd->cmnd[0] = WRITE_SAME_16;
Christoph Hellwig02d26102017-04-05 19:21:02 +0200814 if (unmap)
815 cmd->cmnd[1] = 0x8; /* UNMAP */
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200816 put_unaligned_be64(sector, &cmd->cmnd[2]);
817 put_unaligned_be32(nr_sectors, &cmd->cmnd[10]);
818
819 cmd->allowed = SD_MAX_RETRIES;
820 cmd->transfersize = data_len;
Christoph Hellwig02d26102017-04-05 19:21:02 +0200821 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200822 scsi_req(rq)->resid_len = data_len;
823
824 return scsi_init_io(cmd);
825}
826
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100827static blk_status_t sd_setup_write_same10_cmnd(struct scsi_cmnd *cmd,
828 bool unmap)
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200829{
830 struct scsi_device *sdp = cmd->device;
831 struct request *rq = cmd->request;
832 u64 sector = blk_rq_pos(rq) >> (ilog2(sdp->sector_size) - 9);
833 u32 nr_sectors = blk_rq_sectors(rq) >> (ilog2(sdp->sector_size) - 9);
834 u32 data_len = sdp->sector_size;
835
Jens Axboe61cce6f2018-12-12 06:46:55 -0700836 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200837 if (!rq->special_vec.bv_page)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100838 return BLK_STS_RESOURCE;
Jens Axboe61cce6f2018-12-12 06:46:55 -0700839 clear_highpage(rq->special_vec.bv_page);
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200840 rq->special_vec.bv_offset = 0;
841 rq->special_vec.bv_len = data_len;
842 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
843
844 cmd->cmd_len = 10;
845 cmd->cmnd[0] = WRITE_SAME;
846 if (unmap)
847 cmd->cmnd[1] = 0x8; /* UNMAP */
848 put_unaligned_be32(sector, &cmd->cmnd[2]);
849 put_unaligned_be16(nr_sectors, &cmd->cmnd[7]);
850
851 cmd->allowed = SD_MAX_RETRIES;
852 cmd->transfersize = data_len;
Christoph Hellwig02d26102017-04-05 19:21:02 +0200853 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
Christoph Hellwig81d926e2017-04-05 19:20:59 +0200854 scsi_req(rq)->resid_len = data_len;
855
856 return scsi_init_io(cmd);
FUJITA Tomonorif1126e92010-07-01 19:49:18 +0900857}
858
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100859static blk_status_t sd_setup_write_zeroes_cmnd(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860{
861 struct request *rq = cmd->request;
862 struct scsi_device *sdp = cmd->device;
863 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
Christoph Hellwig02d26102017-04-05 19:21:02 +0200864 u64 sector = blk_rq_pos(rq) >> (ilog2(sdp->sector_size) - 9);
865 u32 nr_sectors = blk_rq_sectors(rq) >> (ilog2(sdp->sector_size) - 9);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
Christoph Hellwige4b87832017-04-05 19:21:12 +0200867 if (!(rq->cmd_flags & REQ_NOUNMAP)) {
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200868 switch (sdkp->zeroing_mode) {
869 case SD_ZERO_WS16_UNMAP:
Damien Le Moal39051dd2017-12-21 15:43:44 +0900870 return sd_setup_write_same16_cmnd(cmd, true);
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200871 case SD_ZERO_WS10_UNMAP:
Damien Le Moal39051dd2017-12-21 15:43:44 +0900872 return sd_setup_write_same10_cmnd(cmd, true);
Christoph Hellwige4b87832017-04-05 19:21:12 +0200873 }
Martin K. Petersene339c1a2009-11-26 12:00:40 -0500874 }
875
Christoph Hellwig02d26102017-04-05 19:21:02 +0200876 if (sdp->no_write_same)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100877 return BLK_STS_TARGET;
Damien Le Moaled44fd72017-05-08 15:48:19 +0900878
Christoph Hellwig02d26102017-04-05 19:21:02 +0200879 if (sdkp->ws16 || sector > 0xffffffff || nr_sectors > 0xffff)
Damien Le Moal39051dd2017-12-21 15:43:44 +0900880 return sd_setup_write_same16_cmnd(cmd, false);
Damien Le Moaled44fd72017-05-08 15:48:19 +0900881
Damien Le Moal39051dd2017-12-21 15:43:44 +0900882 return sd_setup_write_same10_cmnd(cmd, false);
FUJITA Tomonorif1126e92010-07-01 19:49:18 +0900883}
884
Martin K. Petersen5db44862012-09-18 12:19:32 -0400885static void sd_config_write_same(struct scsi_disk *sdkp)
886{
887 struct request_queue *q = sdkp->disk->queue;
888 unsigned int logical_block_size = sdkp->device->sector_size;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400889
890 if (sdkp->device->no_write_same) {
891 sdkp->max_ws_blocks = 0;
892 goto out;
893 }
894
895 /* Some devices can not handle block counts above 0xffff despite
896 * supporting WRITE SAME(16). Consequently we default to 64k
897 * blocks per I/O unless the device explicitly advertises a
898 * bigger limit.
899 */
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400900 if (sdkp->max_ws_blocks > SD_MAX_WS10_BLOCKS)
901 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
902 (u32)SD_MAX_WS16_BLOCKS);
903 else if (sdkp->ws16 || sdkp->ws10 || sdkp->device->no_report_opcodes)
904 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
905 (u32)SD_MAX_WS10_BLOCKS);
906 else {
907 sdkp->device->no_write_same = 1;
908 sdkp->max_ws_blocks = 0;
909 }
Martin K. Petersen5db44862012-09-18 12:19:32 -0400910
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200911 if (sdkp->lbprz && sdkp->lbpws)
912 sdkp->zeroing_mode = SD_ZERO_WS16_UNMAP;
913 else if (sdkp->lbprz && sdkp->lbpws10)
914 sdkp->zeroing_mode = SD_ZERO_WS10_UNMAP;
915 else if (sdkp->max_ws_blocks)
916 sdkp->zeroing_mode = SD_ZERO_WS;
917 else
918 sdkp->zeroing_mode = SD_ZERO_WRITE;
919
Damien Le Moalb7af62a2017-09-05 20:55:35 +0900920 if (sdkp->max_ws_blocks &&
921 sdkp->physical_block_size > logical_block_size) {
922 /*
923 * Reporting a maximum number of blocks that is not aligned
924 * on the device physical size would cause a large write same
925 * request to be split into physically unaligned chunks by
926 * __blkdev_issue_write_zeroes() and __blkdev_issue_write_same()
927 * even if the caller of these functions took care to align the
928 * large request. So make sure the maximum reported is aligned
929 * to the device physical block size. This is only an optional
930 * optimization for regular disks, but this is mandatory to
931 * avoid failure of large write same requests directed at
932 * sequential write required zones of host-managed ZBC disks.
933 */
934 sdkp->max_ws_blocks =
935 round_down(sdkp->max_ws_blocks,
936 bytes_to_logical(sdkp->device,
937 sdkp->physical_block_size));
938 }
939
Martin K. Petersen5db44862012-09-18 12:19:32 -0400940out:
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400941 blk_queue_max_write_same_sectors(q, sdkp->max_ws_blocks *
942 (logical_block_size >> 9));
Christoph Hellwig02d26102017-04-05 19:21:02 +0200943 blk_queue_max_write_zeroes_sectors(q, sdkp->max_ws_blocks *
944 (logical_block_size >> 9));
Martin K. Petersen5db44862012-09-18 12:19:32 -0400945}
946
947/**
948 * sd_setup_write_same_cmnd - write the same data to multiple blocks
Christoph Hellwig59b11342014-06-28 12:22:22 +0200949 * @cmd: command to prepare
Martin K. Petersen5db44862012-09-18 12:19:32 -0400950 *
Damien Le Moal7529fbb2017-04-24 16:51:09 +0900951 * Will set up either WRITE SAME(10) or WRITE SAME(16) depending on
952 * the preference indicated by the target device.
Martin K. Petersen5db44862012-09-18 12:19:32 -0400953 **/
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100954static blk_status_t sd_setup_write_same_cmnd(struct scsi_cmnd *cmd)
Martin K. Petersen5db44862012-09-18 12:19:32 -0400955{
Christoph Hellwig59b11342014-06-28 12:22:22 +0200956 struct request *rq = cmd->request;
957 struct scsi_device *sdp = cmd->device;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400958 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
959 struct bio *bio = rq->bio;
960 sector_t sector = blk_rq_pos(rq);
961 unsigned int nr_sectors = blk_rq_sectors(rq);
Bart Van Assche08965c22017-01-25 13:43:56 -0800962 unsigned int nr_bytes = blk_rq_bytes(rq);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100963 blk_status_t ret;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400964
965 if (sdkp->device->no_write_same)
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100966 return BLK_STS_TARGET;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400967
Kent Overstreeta4ad39b12013-08-07 14:24:32 -0700968 BUG_ON(bio_offset(bio) || bio_iovec(bio).bv_len != sdp->sector_size);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400969
970 sector >>= ilog2(sdp->sector_size) - 9;
971 nr_sectors >>= ilog2(sdp->sector_size) - 9;
972
Martin K. Petersen5db44862012-09-18 12:19:32 -0400973 rq->timeout = SD_WRITE_SAME_TIMEOUT;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400974
975 if (sdkp->ws16 || sector > 0xffffffff || nr_sectors > 0xffff) {
Christoph Hellwig59b11342014-06-28 12:22:22 +0200976 cmd->cmd_len = 16;
977 cmd->cmnd[0] = WRITE_SAME_16;
978 put_unaligned_be64(sector, &cmd->cmnd[2]);
979 put_unaligned_be32(nr_sectors, &cmd->cmnd[10]);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400980 } else {
Christoph Hellwig59b11342014-06-28 12:22:22 +0200981 cmd->cmd_len = 10;
982 cmd->cmnd[0] = WRITE_SAME;
983 put_unaligned_be32(sector, &cmd->cmnd[2]);
984 put_unaligned_be16(nr_sectors, &cmd->cmnd[7]);
Martin K. Petersen5db44862012-09-18 12:19:32 -0400985 }
986
Christoph Hellwig59b11342014-06-28 12:22:22 +0200987 cmd->transfersize = sdp->sector_size;
Christoph Hellwiga25ee542014-06-28 12:29:19 +0200988 cmd->allowed = SD_MAX_RETRIES;
Bart Van Assche08965c22017-01-25 13:43:56 -0800989
990 /*
991 * For WRITE SAME the data transferred via the DATA OUT buffer is
992 * different from the amount of data actually written to the target.
993 *
994 * We set up __data_len to the amount of data transferred via the
995 * DATA OUT buffer so that blk_rq_map_sg sets up the proper S/G list
996 * to transfer a single sector of data first, but then reset it to
997 * the amount of data to be written right after so that the I/O path
998 * knows how much to actually write.
999 */
1000 rq->__data_len = sdp->sector_size;
1001 ret = scsi_init_io(cmd);
1002 rq->__data_len = nr_bytes;
Damien Le Moal29f6ca62017-05-08 14:59:02 +09001003
Bart Van Assche08965c22017-01-25 13:43:56 -08001004 return ret;
Martin K. Petersen5db44862012-09-18 12:19:32 -04001005}
1006
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001007static blk_status_t sd_setup_flush_cmnd(struct scsi_cmnd *cmd)
FUJITA Tomonori90467c22010-07-03 17:45:34 +09001008{
Christoph Hellwiga118c6c2014-06-28 12:08:05 +02001009 struct request *rq = cmd->request;
FUJITA Tomonori90467c22010-07-03 17:45:34 +09001010
Christoph Hellwiga118c6c2014-06-28 12:08:05 +02001011 /* flush requests don't perform I/O, zero the S/G table */
1012 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1013
1014 cmd->cmnd[0] = SYNCHRONIZE_CACHE;
1015 cmd->cmd_len = 10;
1016 cmd->transfersize = 0;
1017 cmd->allowed = SD_MAX_RETRIES;
1018
K. Y. Srinivasan26b9fd82014-07-18 17:11:27 +02001019 rq->timeout = rq->q->rq_timeout * SD_FLUSH_TIMEOUT_MULTIPLIER;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001020 return BLK_STS_OK;
FUJITA Tomonori90467c22010-07-03 17:45:34 +09001021}
1022
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001023static blk_status_t sd_setup_read_write_cmnd(struct scsi_cmnd *SCpnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024{
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001025 struct request *rq = SCpnt->request;
1026 struct scsi_device *sdp = SCpnt->device;
Christoph Hellwig776b23a2006-01-06 18:34:07 +01001027 struct gendisk *disk = rq->rq_disk;
Hannes Reinecke89d94752016-10-18 15:40:34 +09001028 struct scsi_disk *sdkp = scsi_disk(disk);
Tejun Heo83096eb2009-05-07 22:24:39 +09001029 sector_t block = blk_rq_pos(rq);
Linus Torvalds18351072008-08-05 21:42:21 -07001030 sector_t threshold;
Tejun Heo83096eb2009-05-07 22:24:39 +09001031 unsigned int this_count = blk_rq_sectors(rq);
Martin K. Petersenc6115292014-09-26 19:20:08 -04001032 unsigned int dif, dix;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04001033 unsigned char protect;
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001034 blk_status_t ret;
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001035
Christoph Hellwig3c356bd2014-09-05 18:20:23 -07001036 ret = scsi_init_io(SCpnt);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001037 if (ret != BLK_STS_OK)
Damien Le Moal39051dd2017-12-21 15:43:44 +09001038 return ret;
Bart Van Assche0624cbb2017-08-25 13:46:33 -07001039 WARN_ON_ONCE(SCpnt != rq->special);
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001040
Christoph Hellwiga1b73fc2014-05-01 16:51:04 +02001041 SCSI_LOG_HLQUEUE(1,
1042 scmd_printk(KERN_INFO, SCpnt,
1043 "%s: block=%llu, count=%d\n",
1044 __func__, (unsigned long long)block, this_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045
1046 if (!sdp || !scsi_device_online(sdp) ||
Tejun Heo83096eb2009-05-07 22:24:39 +09001047 block + blk_rq_sectors(rq) > get_capacity(disk)) {
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05001048 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
Tejun Heo83096eb2009-05-07 22:24:39 +09001049 "Finishing %u sectors\n",
1050 blk_rq_sectors(rq)));
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05001051 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
1052 "Retry with 0x%p\n", SCpnt));
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001053 return BLK_STS_IOERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 }
1055
1056 if (sdp->changed) {
1057 /*
1058 * quietly refuse to do anything to a changed disc until
1059 * the changed bit has been reset
1060 */
Alan Stern3ff55882010-09-07 11:44:01 -04001061 /* printk("SCSI disk has been changed or is not present. Prohibiting further I/O.\n"); */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001062 return BLK_STS_IOERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 }
James Bottomley7f9a6bc2007-08-04 10:06:25 -05001064
Hans de Goedea0899d42008-01-20 11:12:26 +01001065 /*
Linus Torvalds18351072008-08-05 21:42:21 -07001066 * Some SD card readers can't handle multi-sector accesses which touch
1067 * the last one or two hardware sectors. Split accesses as needed.
Hans de Goedea0899d42008-01-20 11:12:26 +01001068 */
Linus Torvalds18351072008-08-05 21:42:21 -07001069 threshold = get_capacity(disk) - SD_LAST_BUGGY_SECTORS *
1070 (sdp->sector_size / 512);
1071
1072 if (unlikely(sdp->last_sector_bug && block + this_count > threshold)) {
1073 if (block < threshold) {
1074 /* Access up to the threshold but not beyond */
1075 this_count = threshold - block;
1076 } else {
1077 /* Access only a single hardware sector */
1078 this_count = sdp->sector_size / 512;
1079 }
1080 }
Hans de Goedea0899d42008-01-20 11:12:26 +01001081
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05001082 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
1083 (unsigned long long)block));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084
1085 /*
1086 * If we have a 1K hardware sectorsize, prevent access to single
1087 * 512 byte sectors. In theory we could handle this - in fact
1088 * the scsi cdrom driver must be able to handle this because
1089 * we typically use 1K blocksizes, and cdroms typically have
1090 * 2K hardware sectorsizes. Of course, things are simpler
1091 * with the cdrom, since it is read-only. For performance
1092 * reasons, the filesystems should be able to handle this
1093 * and not force the scsi disk driver to use bounce buffers
1094 * for this.
1095 */
1096 if (sdp->sector_size == 1024) {
Tejun Heo83096eb2009-05-07 22:24:39 +09001097 if ((block & 1) || (blk_rq_sectors(rq) & 1)) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05001098 scmd_printk(KERN_ERR, SCpnt,
1099 "Bad block number requested\n");
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001100 return BLK_STS_IOERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 }
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001102 block = block >> 1;
1103 this_count = this_count >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 }
1105 if (sdp->sector_size == 2048) {
Tejun Heo83096eb2009-05-07 22:24:39 +09001106 if ((block & 3) || (blk_rq_sectors(rq) & 3)) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05001107 scmd_printk(KERN_ERR, SCpnt,
1108 "Bad block number requested\n");
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001109 return BLK_STS_IOERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 }
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001111 block = block >> 2;
1112 this_count = this_count >> 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 }
1114 if (sdp->sector_size == 4096) {
Tejun Heo83096eb2009-05-07 22:24:39 +09001115 if ((block & 7) || (blk_rq_sectors(rq) & 7)) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05001116 scmd_printk(KERN_ERR, SCpnt,
1117 "Bad block number requested\n");
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001118 return BLK_STS_IOERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 }
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001120 block = block >> 3;
1121 this_count = this_count >> 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 }
1123 if (rq_data_dir(rq) == WRITE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 SCpnt->cmnd[0] = WRITE_6;
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001125
Martin K. Petersen8c579ab2012-08-28 14:29:33 -04001126 if (blk_integrity_rq(rq))
Max Gurtovoy10c41dd2018-07-30 00:15:32 +03001127 t10_pi_prepare(SCpnt->request, sdkp->protection_type);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 } else if (rq_data_dir(rq) == READ) {
1130 SCpnt->cmnd[0] = READ_6;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 } else {
Christoph Hellwigef295ec2016-10-28 08:48:16 -06001132 scmd_printk(KERN_ERR, SCpnt, "Unknown command %d\n", req_op(rq));
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001133 return BLK_STS_IOERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 }
1135
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05001136 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
Tejun Heo83096eb2009-05-07 22:24:39 +09001137 "%s %d/%u 512 byte blocks.\n",
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05001138 (rq_data_dir(rq) == WRITE) ?
1139 "writing" : "reading", this_count,
Tejun Heo83096eb2009-05-07 22:24:39 +09001140 blk_rq_sectors(rq)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
Martin K. Petersenc6115292014-09-26 19:20:08 -04001142 dix = scsi_prot_sg_count(SCpnt);
1143 dif = scsi_host_dif_capable(SCpnt->device->host, sdkp->protection_type);
1144
1145 if (dif || dix)
1146 protect = sd_setup_protect_cmnd(SCpnt, dix, dif);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001147 else
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04001148 protect = 0;
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001149
Christoph Hellwig8475c812016-09-11 19:35:41 +02001150 if (protect && sdkp->protection_type == T10_PI_TYPE2_PROTECTION) {
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04001151 SCpnt->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
1152
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001153 if (unlikely(!SCpnt->cmnd))
1154 return BLK_STS_RESOURCE;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04001155
1156 SCpnt->cmd_len = SD_EXT_CDB_SIZE;
1157 memset(SCpnt->cmnd, 0, SCpnt->cmd_len);
1158 SCpnt->cmnd[0] = VARIABLE_LENGTH_CMD;
1159 SCpnt->cmnd[7] = 0x18;
1160 SCpnt->cmnd[9] = (rq_data_dir(rq) == READ) ? READ_32 : WRITE_32;
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001161 SCpnt->cmnd[10] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04001162
1163 /* LBA */
1164 SCpnt->cmnd[12] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
1165 SCpnt->cmnd[13] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
1166 SCpnt->cmnd[14] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
1167 SCpnt->cmnd[15] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
1168 SCpnt->cmnd[16] = (unsigned char) (block >> 24) & 0xff;
1169 SCpnt->cmnd[17] = (unsigned char) (block >> 16) & 0xff;
1170 SCpnt->cmnd[18] = (unsigned char) (block >> 8) & 0xff;
1171 SCpnt->cmnd[19] = (unsigned char) block & 0xff;
1172
1173 /* Expected Indirect LBA */
1174 SCpnt->cmnd[20] = (unsigned char) (block >> 24) & 0xff;
1175 SCpnt->cmnd[21] = (unsigned char) (block >> 16) & 0xff;
1176 SCpnt->cmnd[22] = (unsigned char) (block >> 8) & 0xff;
1177 SCpnt->cmnd[23] = (unsigned char) block & 0xff;
1178
1179 /* Transfer length */
1180 SCpnt->cmnd[28] = (unsigned char) (this_count >> 24) & 0xff;
1181 SCpnt->cmnd[29] = (unsigned char) (this_count >> 16) & 0xff;
1182 SCpnt->cmnd[30] = (unsigned char) (this_count >> 8) & 0xff;
1183 SCpnt->cmnd[31] = (unsigned char) this_count & 0xff;
Akinobu Mitae430cbc2014-06-02 22:56:47 +09001184 } else if (sdp->use_16_for_rw || (this_count > 0xffff)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 SCpnt->cmnd[0] += READ_16 - READ_6;
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001186 SCpnt->cmnd[1] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
1188 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
1189 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
1190 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
1191 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
1192 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
1193 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
1194 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
1195 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
1196 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
1197 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
1198 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
1199 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
1200 } else if ((this_count > 0xff) || (block > 0x1fffff) ||
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001201 scsi_device_protection(SCpnt->device) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 SCpnt->device->use_10_for_rw) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 SCpnt->cmnd[0] += READ_10 - READ_6;
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001204 SCpnt->cmnd[1] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
1206 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
1207 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
1208 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
1209 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
1210 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
1211 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
1212 } else {
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001213 if (unlikely(rq->cmd_flags & REQ_FUA)) {
Tejun Heo007365a2006-01-06 09:53:52 +01001214 /*
1215 * This happens only if this drive failed
1216 * 10byte rw command with ILLEGAL_REQUEST
1217 * during operation and thus turned off
1218 * use_10_for_rw.
1219 */
Martin K. Petersene73aec82007-02-27 22:40:55 -05001220 scmd_printk(KERN_ERR, SCpnt,
1221 "FUA write on READ/WRITE(6) drive\n");
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001222 return BLK_STS_IOERR;
Tejun Heo007365a2006-01-06 09:53:52 +01001223 }
1224
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
1226 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
1227 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
1228 SCpnt->cmnd[4] = (unsigned char) this_count;
1229 SCpnt->cmnd[5] = 0;
1230 }
Boaz Harrosh30b0c372007-12-13 13:47:40 +02001231 SCpnt->sdb.length = this_count * sdp->sector_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232
1233 /*
1234 * We shouldn't disconnect in the middle of a sector, so with a dumb
1235 * host adapter, it's safe to assume that we can at least transfer
1236 * this many bytes between each connect / disconnect.
1237 */
1238 SCpnt->transfersize = sdp->sector_size;
1239 SCpnt->underflow = this_count << 9;
1240 SCpnt->allowed = SD_MAX_RETRIES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
1242 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 * This indicates that the command is ready from our end to be
1244 * queued.
1245 */
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001246 return BLK_STS_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247}
1248
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001249static blk_status_t sd_init_command(struct scsi_cmnd *cmd)
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001250{
1251 struct request *rq = cmd->request;
1252
Mike Christiec2df40d2016-06-05 14:32:17 -05001253 switch (req_op(rq)) {
1254 case REQ_OP_DISCARD:
Christoph Hellwig81d926e2017-04-05 19:20:59 +02001255 switch (scsi_disk(rq->rq_disk)->provisioning_mode) {
1256 case SD_LBP_UNMAP:
1257 return sd_setup_unmap_cmnd(cmd);
1258 case SD_LBP_WS16:
Christoph Hellwig02d26102017-04-05 19:21:02 +02001259 return sd_setup_write_same16_cmnd(cmd, true);
Christoph Hellwig81d926e2017-04-05 19:20:59 +02001260 case SD_LBP_WS10:
1261 return sd_setup_write_same10_cmnd(cmd, true);
1262 case SD_LBP_ZERO:
1263 return sd_setup_write_same10_cmnd(cmd, false);
1264 default:
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001265 return BLK_STS_TARGET;
Christoph Hellwig81d926e2017-04-05 19:20:59 +02001266 }
Christoph Hellwig02d26102017-04-05 19:21:02 +02001267 case REQ_OP_WRITE_ZEROES:
1268 return sd_setup_write_zeroes_cmnd(cmd);
Mike Christiec2df40d2016-06-05 14:32:17 -05001269 case REQ_OP_WRITE_SAME:
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001270 return sd_setup_write_same_cmnd(cmd);
Mike Christie3a5e02c2016-06-05 14:32:23 -05001271 case REQ_OP_FLUSH:
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001272 return sd_setup_flush_cmnd(cmd);
Mike Christiec2df40d2016-06-05 14:32:17 -05001273 case REQ_OP_READ:
1274 case REQ_OP_WRITE:
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001275 return sd_setup_read_write_cmnd(cmd);
Hannes Reinecke89d94752016-10-18 15:40:34 +09001276 case REQ_OP_ZONE_RESET:
1277 return sd_zbc_setup_reset_cmnd(cmd);
Mike Christiec2df40d2016-06-05 14:32:17 -05001278 default:
Johannes Thumshirnf1f1fad2018-09-21 09:01:01 +02001279 WARN_ON_ONCE(1);
Christoph Hellwig159b2cb2018-11-09 14:42:39 +01001280 return BLK_STS_NOTSUPP;
Mike Christiec2df40d2016-06-05 14:32:17 -05001281 }
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001282}
1283
1284static void sd_uninit_command(struct scsi_cmnd *SCpnt)
1285{
1286 struct request *rq = SCpnt->request;
Bart Van Assche14e30622017-12-05 16:57:51 -08001287 u8 *cmnd;
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001288
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001289 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
Jens Axboe61cce6f2018-12-12 06:46:55 -07001290 mempool_free(rq->special_vec.bv_page, sd_page_pool);
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001291
Christoph Hellwig82ed4db2017-01-27 09:46:29 +01001292 if (SCpnt->cmnd != scsi_req(rq)->cmd) {
Bart Van Assche14e30622017-12-05 16:57:51 -08001293 cmnd = SCpnt->cmnd;
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001294 SCpnt->cmnd = NULL;
1295 SCpnt->cmd_len = 0;
Bart Van Assche14e30622017-12-05 16:57:51 -08001296 mempool_free(cmnd, sd_cdb_pool);
Christoph Hellwig87949ee2014-06-28 12:40:18 +02001297 }
1298}
1299
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300/**
1301 * sd_open - open a scsi disk device
Damien Le Moal7529fbb2017-04-24 16:51:09 +09001302 * @bdev: Block device of the scsi disk to open
1303 * @mode: FMODE_* mask
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 *
1305 * Returns 0 if successful. Returns a negated errno value in case
1306 * of error.
1307 *
1308 * Note: This can be called from a user context (e.g. fsck(1) )
1309 * or from within the kernel (e.g. as a result of a mount(1) ).
1310 * In the latter case @inode and @filp carry an abridged amount
1311 * of information as noted above.
Arnd Bergmann409f3492010-07-07 16:51:29 +02001312 *
1313 * Locking: called with bdev->bd_mutex held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 **/
Al Viro0338e292008-03-02 10:41:04 -05001315static int sd_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
Al Viro0338e292008-03-02 10:41:04 -05001317 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 struct scsi_device *sdev;
1319 int retval;
1320
Al Viro0338e292008-03-02 10:41:04 -05001321 if (!sdkp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 return -ENXIO;
1323
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05001324 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
1326 sdev = sdkp->device;
1327
1328 /*
1329 * If the device is in error recovery, wait until it is done.
1330 * If the device is offline, then disallow any access to it.
1331 */
1332 retval = -ENXIO;
1333 if (!scsi_block_when_processing_errors(sdev))
1334 goto error_out;
1335
1336 if (sdev->removable || sdkp->write_prot)
Al Viro0338e292008-03-02 10:41:04 -05001337 check_disk_change(bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
1339 /*
1340 * If the drive is empty, just let the open fail.
1341 */
1342 retval = -ENOMEDIUM;
Al Viro0338e292008-03-02 10:41:04 -05001343 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 goto error_out;
1345
1346 /*
1347 * If the device has the write protect tab set, have the open fail
1348 * if the user expects to be able to write to the thing.
1349 */
1350 retval = -EROFS;
Al Viro0338e292008-03-02 10:41:04 -05001351 if (sdkp->write_prot && (mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 goto error_out;
1353
1354 /*
1355 * It is possible that the disk changing stuff resulted in
1356 * the device being taken offline. If this is the case,
1357 * report this to the user, and don't pretend that the
1358 * open actually succeeded.
1359 */
1360 retval = -ENXIO;
1361 if (!scsi_device_online(sdev))
1362 goto error_out;
1363
Arnd Bergmann409f3492010-07-07 16:51:29 +02001364 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 if (scsi_block_when_processing_errors(sdev))
1366 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1367 }
1368
1369 return 0;
1370
1371error_out:
1372 scsi_disk_put(sdkp);
1373 return retval;
1374}
1375
1376/**
1377 * sd_release - invoked when the (last) close(2) is called on this
1378 * scsi disk.
Damien Le Moal7529fbb2017-04-24 16:51:09 +09001379 * @disk: disk to release
1380 * @mode: FMODE_* mask
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 *
1382 * Returns 0.
1383 *
1384 * Note: may block (uninterruptible) if error recovery is underway
1385 * on this disk.
Arnd Bergmann409f3492010-07-07 16:51:29 +02001386 *
1387 * Locking: called with bdev->bd_mutex held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 **/
Al Virodb2a1442013-05-05 21:52:57 -04001389static void sd_release(struct gendisk *disk, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 struct scsi_disk *sdkp = scsi_disk(disk);
1392 struct scsi_device *sdev = sdkp->device;
1393
James Bottomley56937f72007-03-11 12:25:33 -05001394 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Alan Stern7e443312010-09-07 11:27:52 -04001396 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 if (scsi_block_when_processing_errors(sdev))
1398 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1399 }
1400
1401 /*
1402 * XXX and what if there are packets in flight and this close()
1403 * XXX is followed by a "rmmod sd_mod"?
1404 */
Alan Stern478a8a02010-06-16 14:52:17 -04001405
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 scsi_disk_put(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407}
1408
Christoph Hellwiga885c8c2006-01-08 01:02:50 -08001409static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410{
1411 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1412 struct scsi_device *sdp = sdkp->device;
1413 struct Scsi_Host *host = sdp->host;
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04001414 sector_t capacity = logical_to_sectors(sdp, sdkp->capacity);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 int diskinfo[4];
1416
1417 /* default to most commonly used values */
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04001418 diskinfo[0] = 0x40; /* 1 << 6 */
1419 diskinfo[1] = 0x20; /* 1 << 5 */
1420 diskinfo[2] = capacity >> 11;
1421
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 /* override with calculated, extended default, or driver values */
1423 if (host->hostt->bios_param)
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04001424 host->hostt->bios_param(sdp, bdev, capacity, diskinfo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 else
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04001426 scsicam_bios_param(bdev, capacity, diskinfo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Christoph Hellwiga885c8c2006-01-08 01:02:50 -08001428 geo->heads = diskinfo[0];
1429 geo->sectors = diskinfo[1];
1430 geo->cylinders = diskinfo[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 return 0;
1432}
1433
1434/**
1435 * sd_ioctl - process an ioctl
Damien Le Moal7529fbb2017-04-24 16:51:09 +09001436 * @bdev: target block device
1437 * @mode: FMODE_* mask
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 * @cmd: ioctl command number
1439 * @arg: this is third argument given to ioctl(2) system call.
1440 * Often contains a pointer.
1441 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001442 * Returns 0 if successful (some ioctls return positive numbers on
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 * success as well). Returns a negated errno value in case of error.
1444 *
1445 * Note: most ioctls are forward onto the block subsystem or further
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02001446 * down in the scsi subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 **/
Al Viro0338e292008-03-02 10:41:04 -05001448static int sd_ioctl(struct block_device *bdev, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 unsigned int cmd, unsigned long arg)
1450{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 struct gendisk *disk = bdev->bd_disk;
Nao Nishijimafe2d1852011-08-25 18:04:14 +09001452 struct scsi_disk *sdkp = scsi_disk(disk);
1453 struct scsi_device *sdp = sdkp->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 void __user *p = (void __user *)arg;
1455 int error;
1456
Nao Nishijimafe2d1852011-08-25 18:04:14 +09001457 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1458 "cmd=0x%x\n", disk->disk_name, cmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +01001460 error = scsi_verify_blk_ioctl(bdev, cmd);
1461 if (error < 0)
1462 return error;
1463
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 /*
1465 * If we are in the middle of error recovery, don't let anyone
1466 * else try and use this device. Also, if error recovery fails, it
1467 * may try and take the device offline, in which case all further
1468 * access to the device is prohibited.
1469 */
Christoph Hellwig906d15f2014-10-11 16:25:31 +02001470 error = scsi_ioctl_block_when_processing_errors(sdp, cmd,
1471 (mode & FMODE_NDELAY) != 0);
1472 if (error)
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001473 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
Christoph Hellwigd80210f2017-06-19 14:26:46 +02001475 if (is_sed_ioctl(cmd))
1476 return sed_ioctl(sdkp->opal_dev, cmd, p);
1477
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 /*
1479 * Send SCSI addressing ioctls directly to mid level, send other
1480 * ioctls to block level and then onto mid level if they can't be
1481 * resolved.
1482 */
1483 switch (cmd) {
1484 case SCSI_IOCTL_GET_IDLUN:
1485 case SCSI_IOCTL_GET_BUS_NUMBER:
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001486 error = scsi_ioctl(sdp, cmd, p);
1487 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 default:
Paolo Bonzini577ebb32012-01-12 16:01:27 +01001489 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 if (error != -ENOTTY)
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001491 break;
1492 error = scsi_ioctl(sdp, cmd, p);
1493 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 }
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001495out:
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001496 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497}
1498
1499static void set_media_not_present(struct scsi_disk *sdkp)
1500{
Tejun Heo2bae0092010-12-18 18:42:23 +01001501 if (sdkp->media_present)
1502 sdkp->device->changed = 1;
1503
1504 if (sdkp->device->removable) {
1505 sdkp->media_present = 0;
1506 sdkp->capacity = 0;
1507 }
1508}
1509
1510static int media_not_present(struct scsi_disk *sdkp,
1511 struct scsi_sense_hdr *sshdr)
1512{
1513 if (!scsi_sense_valid(sshdr))
1514 return 0;
1515
1516 /* not invoked for commands that could return deferred errors */
1517 switch (sshdr->sense_key) {
1518 case UNIT_ATTENTION:
1519 case NOT_READY:
1520 /* medium not present */
1521 if (sshdr->asc == 0x3A) {
1522 set_media_not_present(sdkp);
1523 return 1;
1524 }
1525 }
1526 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527}
1528
1529/**
Tejun Heo2bae0092010-12-18 18:42:23 +01001530 * sd_check_events - check media events
1531 * @disk: kernel device descriptor
1532 * @clearing: disk events currently being cleared
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 *
Tejun Heo2bae0092010-12-18 18:42:23 +01001534 * Returns mask of DISK_EVENT_*.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 *
1536 * Note: this function is invoked from the block subsystem.
1537 **/
Tejun Heo2bae0092010-12-18 18:42:23 +01001538static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539{
Hannes Reineckeeb72d0b2016-04-26 08:06:58 +02001540 struct scsi_disk *sdkp = scsi_disk_get(disk);
1541 struct scsi_device *sdp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 int retval;
1543
Hannes Reineckeeb72d0b2016-04-26 08:06:58 +02001544 if (!sdkp)
1545 return 0;
1546
1547 sdp = sdkp->device;
Tejun Heo2bae0092010-12-18 18:42:23 +01001548 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
1550 /*
1551 * If the device is offline, don't send any commands - just pretend as
1552 * if the command failed. If the device ever comes back online, we
1553 * can deal with it then. It is only because of unrecoverable errors
1554 * that we would ever take a device offline in the first place.
1555 */
Kay Sievers285e9672007-08-14 14:10:39 +02001556 if (!scsi_device_online(sdp)) {
1557 set_media_not_present(sdkp);
Kay Sievers285e9672007-08-14 14:10:39 +02001558 goto out;
1559 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
1561 /*
1562 * Using TEST_UNIT_READY enables differentiation between drive with
1563 * no cartridge loaded - NOT READY, drive with changed cartridge -
1564 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1565 *
1566 * Drives that auto spin down. eg iomega jaz 1G, will be started
1567 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1568 * sd_revalidate() is called.
1569 */
James Bottomley001aac22007-12-02 19:10:40 +02001570 if (scsi_block_when_processing_errors(sdp)) {
Christoph Hellwig6fa2b8f2017-02-14 20:15:56 +01001571 struct scsi_sense_hdr sshdr = { 0, };
1572
James Bottomley001aac22007-12-02 19:10:40 +02001573 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
Christoph Hellwig6fa2b8f2017-02-14 20:15:56 +01001574 &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
Christoph Hellwig6fa2b8f2017-02-14 20:15:56 +01001576 /* failed to execute TUR, assume media not present */
1577 if (host_byte(retval)) {
1578 set_media_not_present(sdkp);
1579 goto out;
1580 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Christoph Hellwig6fa2b8f2017-02-14 20:15:56 +01001582 if (media_not_present(sdkp, &sshdr))
1583 goto out;
1584 }
Tejun Heo2bae0092010-12-18 18:42:23 +01001585
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 /*
1587 * For removable scsi disk we have to recognise the presence
Tejun Heo2bae0092010-12-18 18:42:23 +01001588 * of a disk in the drive.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 */
Tejun Heo2bae0092010-12-18 18:42:23 +01001590 if (!sdkp->media_present)
1591 sdp->changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 sdkp->media_present = 1;
Kay Sievers285e9672007-08-14 14:10:39 +02001593out:
Alan Stern3ff55882010-09-07 11:44:01 -04001594 /*
Tejun Heo2bae0092010-12-18 18:42:23 +01001595 * sdp->changed is set under the following conditions:
Alan Stern3ff55882010-09-07 11:44:01 -04001596 *
Tejun Heo2bae0092010-12-18 18:42:23 +01001597 * Medium present state has changed in either direction.
1598 * Device has indicated UNIT_ATTENTION.
Alan Stern3ff55882010-09-07 11:44:01 -04001599 */
Tejun Heo2bae0092010-12-18 18:42:23 +01001600 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1601 sdp->changed = 0;
Hannes Reineckeeb72d0b2016-04-26 08:06:58 +02001602 scsi_disk_put(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604}
1605
Derek Basehore4fa83242017-05-11 14:34:24 +02001606static int sd_sync_cache(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 int retries, res;
Martin K. Petersene73aec82007-02-27 22:40:55 -05001609 struct scsi_device *sdp = sdkp->device;
James Bottomley7e660102013-10-04 21:42:24 +00001610 const int timeout = sdp->request_queue->rq_timeout
1611 * SD_FLUSH_TIMEOUT_MULTIPLIER;
Derek Basehore4fa83242017-05-11 14:34:24 +02001612 struct scsi_sense_hdr my_sshdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
1614 if (!scsi_device_online(sdp))
1615 return -ENODEV;
1616
Derek Basehore4fa83242017-05-11 14:34:24 +02001617 /* caller might not be interested in sense, but we need it */
1618 if (!sshdr)
1619 sshdr = &my_sshdr;
1620
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 for (retries = 3; retries > 0; --retries) {
1622 unsigned char cmd[10] = { 0 };
1623
1624 cmd[0] = SYNCHRONIZE_CACHE;
1625 /*
1626 * Leave the rest of the command zero to indicate
1627 * flush everything.
1628 */
Derek Basehore4fa83242017-05-11 14:34:24 +02001629 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, sshdr,
Christoph Hellwigfcbfffe2017-02-23 16:02:37 +01001630 timeout, SD_MAX_RETRIES, 0, RQF_PM, NULL);
James Bottomleyea73a9f2005-08-28 11:33:52 -05001631 if (res == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 break;
1633 }
1634
Martin K. Petersene73aec82007-02-27 22:40:55 -05001635 if (res) {
Hannes Reineckeef613292014-10-24 14:27:00 +02001636 sd_print_result(sdkp, "Synchronize Cache(10) failed", res);
Oliver Neukum95897912013-09-16 13:28:15 +02001637
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02001638 if (driver_byte(res) == DRIVER_SENSE)
Derek Basehore4fa83242017-05-11 14:34:24 +02001639 sd_print_sense_hdr(sdkp, sshdr);
1640
Oliver Neukum95897912013-09-16 13:28:15 +02001641 /* we need to evaluate the error return */
Derek Basehore4fa83242017-05-11 14:34:24 +02001642 if (scsi_sense_valid(sshdr) &&
1643 (sshdr->asc == 0x3a || /* medium not present */
1644 sshdr->asc == 0x20)) /* invalid command */
Oliver Neukum95897912013-09-16 13:28:15 +02001645 /* this is no error here */
1646 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
Oliver Neukum95897912013-09-16 13:28:15 +02001648 switch (host_byte(res)) {
1649 /* ignore errors due to racing a disconnection */
1650 case DID_BAD_TARGET:
1651 case DID_NO_CONNECT:
1652 return 0;
1653 /* signal the upper layer it might try again */
1654 case DID_BUS_BUSY:
1655 case DID_IMM_RETRY:
1656 case DID_REQUEUE:
1657 case DID_SOFT_ERROR:
1658 return -EBUSY;
1659 default:
1660 return -EIO;
1661 }
1662 }
Tejun Heo37210502007-03-21 00:07:18 +09001663 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664}
1665
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666static void sd_rescan(struct device *dev)
1667{
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01001668 struct scsi_disk *sdkp = dev_get_drvdata(dev);
Alan Stern39b7f1e2005-11-04 14:44:41 -05001669
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01001670 revalidate_disk(sdkp->disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671}
1672
1673
1674#ifdef CONFIG_COMPAT
1675/*
1676 * This gets directly called from VFS. When the ioctl
1677 * is not recognized we go back to the other translation paths.
1678 */
Al Viro0338e292008-03-02 10:41:04 -05001679static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1680 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681{
Al Viro0338e292008-03-02 10:41:04 -05001682 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
Christoph Hellwig21a9d4c2014-10-24 18:39:37 +02001683 int error;
Paolo Bonzini0bfc96c2012-01-12 16:01:28 +01001684
Christoph Hellwig21a9d4c2014-10-24 18:39:37 +02001685 error = scsi_ioctl_block_when_processing_errors(sdev, cmd,
1686 (mode & FMODE_NDELAY) != 0);
1687 if (error)
1688 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 /*
1691 * Let the static ioctl translation table take care of it.
1692 */
Christoph Hellwig21a9d4c2014-10-24 18:39:37 +02001693 if (!sdev->host->hostt->compat_ioctl)
1694 return -ENOIOCTLCMD;
1695 return sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696}
1697#endif
1698
Christoph Hellwig924d55b2015-10-15 14:10:49 +02001699static char sd_pr_type(enum pr_type type)
1700{
1701 switch (type) {
1702 case PR_WRITE_EXCLUSIVE:
1703 return 0x01;
1704 case PR_EXCLUSIVE_ACCESS:
1705 return 0x03;
1706 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1707 return 0x05;
1708 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1709 return 0x06;
1710 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1711 return 0x07;
1712 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1713 return 0x08;
1714 default:
1715 return 0;
1716 }
1717};
1718
1719static int sd_pr_command(struct block_device *bdev, u8 sa,
1720 u64 key, u64 sa_key, u8 type, u8 flags)
1721{
1722 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1723 struct scsi_sense_hdr sshdr;
1724 int result;
1725 u8 cmd[16] = { 0, };
1726 u8 data[24] = { 0, };
1727
1728 cmd[0] = PERSISTENT_RESERVE_OUT;
1729 cmd[1] = sa;
1730 cmd[2] = type;
1731 put_unaligned_be32(sizeof(data), &cmd[5]);
1732
1733 put_unaligned_be64(key, &data[0]);
1734 put_unaligned_be64(sa_key, &data[8]);
1735 data[20] = flags;
1736
1737 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, &data, sizeof(data),
1738 &sshdr, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1739
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02001740 if (driver_byte(result) == DRIVER_SENSE &&
1741 scsi_sense_valid(&sshdr)) {
Christoph Hellwig924d55b2015-10-15 14:10:49 +02001742 sdev_printk(KERN_INFO, sdev, "PR command failed: %d\n", result);
1743 scsi_print_sense_hdr(sdev, NULL, &sshdr);
1744 }
1745
1746 return result;
1747}
1748
1749static int sd_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
1750 u32 flags)
1751{
1752 if (flags & ~PR_FL_IGNORE_KEY)
1753 return -EOPNOTSUPP;
1754 return sd_pr_command(bdev, (flags & PR_FL_IGNORE_KEY) ? 0x06 : 0x00,
1755 old_key, new_key, 0,
Christoph Hellwig01f90dd2016-07-08 21:23:50 +09001756 (1 << 0) /* APTPL */);
Christoph Hellwig924d55b2015-10-15 14:10:49 +02001757}
1758
1759static int sd_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
1760 u32 flags)
1761{
1762 if (flags)
1763 return -EOPNOTSUPP;
1764 return sd_pr_command(bdev, 0x01, key, 0, sd_pr_type(type), 0);
1765}
1766
1767static int sd_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1768{
1769 return sd_pr_command(bdev, 0x02, key, 0, sd_pr_type(type), 0);
1770}
1771
1772static int sd_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
1773 enum pr_type type, bool abort)
1774{
1775 return sd_pr_command(bdev, abort ? 0x05 : 0x04, old_key, new_key,
1776 sd_pr_type(type), 0);
1777}
1778
1779static int sd_pr_clear(struct block_device *bdev, u64 key)
1780{
1781 return sd_pr_command(bdev, 0x03, key, 0, 0, 0);
1782}
1783
1784static const struct pr_ops sd_pr_ops = {
1785 .pr_register = sd_pr_register,
1786 .pr_reserve = sd_pr_reserve,
1787 .pr_release = sd_pr_release,
1788 .pr_preempt = sd_pr_preempt,
1789 .pr_clear = sd_pr_clear,
1790};
1791
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -07001792static const struct block_device_operations sd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 .owner = THIS_MODULE,
Al Viro0338e292008-03-02 10:41:04 -05001794 .open = sd_open,
1795 .release = sd_release,
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +02001796 .ioctl = sd_ioctl,
Christoph Hellwiga885c8c2006-01-08 01:02:50 -08001797 .getgeo = sd_getgeo,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798#ifdef CONFIG_COMPAT
Al Viro0338e292008-03-02 10:41:04 -05001799 .compat_ioctl = sd_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800#endif
Tejun Heo2bae0092010-12-18 18:42:23 +01001801 .check_events = sd_check_events,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 .revalidate_disk = sd_revalidate_disk,
Tejun Heo72ec24b2010-05-15 20:09:32 +02001803 .unlock_native_capacity = sd_unlock_native_capacity,
Christoph Hellwige76239a2018-10-12 19:08:49 +09001804 .report_zones = sd_zbc_report_zones,
Christoph Hellwig924d55b2015-10-15 14:10:49 +02001805 .pr_ops = &sd_pr_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806};
1807
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001808/**
Hannes Reinecke7a38dc0b2017-04-06 15:36:29 +02001809 * sd_eh_reset - reset error handling callback
1810 * @scmd: sd-issued command that has failed
1811 *
1812 * This function is called by the SCSI midlayer before starting
1813 * SCSI EH. When counting medium access failures we have to be
1814 * careful to register it only only once per device and SCSI EH run;
1815 * there might be several timed out commands which will cause the
1816 * 'max_medium_access_timeouts' counter to trigger after the first
1817 * SCSI EH run already and set the device to offline.
1818 * So this function resets the internal counter before starting SCSI EH.
1819 **/
1820static void sd_eh_reset(struct scsi_cmnd *scmd)
1821{
1822 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1823
1824 /* New SCSI EH run, reset gate variable */
1825 sdkp->ignore_medium_access_errors = false;
1826}
1827
1828/**
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001829 * sd_eh_action - error handling callback
1830 * @scmd: sd-issued command that has failed
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001831 * @eh_disp: The recovery disposition suggested by the midlayer
1832 *
James Bottomley24510792013-11-11 13:44:53 +01001833 * This function is called by the SCSI midlayer upon completion of an
1834 * error test command (currently TEST UNIT READY). The result of sending
1835 * the eh command is passed in eh_disp. We're looking for devices that
1836 * fail medium access commands but are OK with non access commands like
1837 * test unit ready (so wrongly see the device as having a successful
1838 * recovery)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001839 **/
James Bottomley24510792013-11-11 13:44:53 +01001840static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001841{
1842 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001843 struct scsi_device *sdev = scmd->device;
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001844
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001845 if (!scsi_device_online(sdev) ||
James Bottomley24510792013-11-11 13:44:53 +01001846 !scsi_medium_access_command(scmd) ||
1847 host_byte(scmd->result) != DID_TIME_OUT ||
1848 eh_disp != SUCCESS)
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001849 return eh_disp;
1850
1851 /*
1852 * The device has timed out executing a medium access command.
1853 * However, the TEST UNIT READY command sent during error
1854 * handling completed successfully. Either the device is in the
1855 * process of recovering or has it suffered an internal failure
1856 * that prevents access to the storage medium.
1857 */
Hannes Reinecke7a38dc0b2017-04-06 15:36:29 +02001858 if (!sdkp->ignore_medium_access_errors) {
1859 sdkp->medium_access_timed_out++;
1860 sdkp->ignore_medium_access_errors = true;
1861 }
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001862
1863 /*
1864 * If the device keeps failing read/write commands but TEST UNIT
1865 * READY always completes successfully we assume that medium
1866 * access is no longer possible and take the device offline.
1867 */
1868 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1869 scmd_printk(KERN_ERR, scmd,
1870 "Medium access timeout failure. Offlining disk!\n");
Bart Van Assche0db6ca82017-06-02 14:21:55 -07001871 mutex_lock(&sdev->state_mutex);
1872 scsi_device_set_state(sdev, SDEV_OFFLINE);
1873 mutex_unlock(&sdev->state_mutex);
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001874
Hannes Reineckee8f8d502017-04-06 15:36:30 +02001875 return SUCCESS;
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001876 }
1877
1878 return eh_disp;
1879}
1880
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001881static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1882{
Damien Le Moal6eadc612017-04-24 16:51:10 +09001883 struct request *req = scmd->request;
1884 struct scsi_device *sdev = scmd->device;
1885 unsigned int transferred, good_bytes;
1886 u64 start_lba, end_lba, bad_lba;
1887
1888 /*
1889 * Some commands have a payload smaller than the device logical
1890 * block size (e.g. INQUIRY on a 4K disk).
1891 */
1892 if (scsi_bufflen(scmd) <= sdev->sector_size)
1893 return 0;
1894
1895 /* Check if we have a 'bad_lba' information */
1896 if (!scsi_get_sense_info_fld(scmd->sense_buffer,
1897 SCSI_SENSE_BUFFERSIZE,
1898 &bad_lba))
1899 return 0;
1900
1901 /*
1902 * If the bad lba was reported incorrectly, we have no idea where
1903 * the error is.
1904 */
1905 start_lba = sectors_to_logical(sdev, blk_rq_pos(req));
1906 end_lba = start_lba + bytes_to_logical(sdev, scsi_bufflen(scmd));
1907 if (bad_lba < start_lba || bad_lba >= end_lba)
1908 return 0;
1909
James Bottomleya8733c72010-12-17 15:36:34 -05001910 /*
1911 * resid is optional but mostly filled in. When it's unused,
1912 * its value is zero, so we assume the whole buffer transferred
1913 */
Damien Le Moal6eadc612017-04-24 16:51:10 +09001914 transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001915
Damien Le Moal6eadc612017-04-24 16:51:10 +09001916 /* This computation should always be done in terms of the
1917 * resolution of the device's medium.
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001918 */
Damien Le Moal6eadc612017-04-24 16:51:10 +09001919 good_bytes = logical_to_bytes(sdev, bad_lba - start_lba);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001920
James Bottomleya8733c72010-12-17 15:36:34 -05001921 return min(good_bytes, transferred);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001922}
1923
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924/**
Linus Torvalds7b3d9542008-01-06 10:17:12 -08001925 * sd_done - bottom half handler: called when the lower level
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 * driver has completed (successfully or otherwise) a scsi command.
1927 * @SCpnt: mid-level's per command structure.
1928 *
1929 * Note: potentially run from within an ISR. Must not block.
1930 **/
Linus Torvalds7b3d9542008-01-06 10:17:12 -08001931static int sd_done(struct scsi_cmnd *SCpnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932{
1933 int result = SCpnt->result;
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001934 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
Damien Le Moalc46f0912017-03-01 17:27:00 +09001935 unsigned int sector_size = SCpnt->device->sector_size;
1936 unsigned int resid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 struct scsi_sense_hdr sshdr;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04001938 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
Martin K. Petersen26e85fc2012-09-18 12:19:31 -04001939 struct request *req = SCpnt->request;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 int sense_valid = 0;
1941 int sense_deferred = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
Hannes Reinecke89d94752016-10-18 15:40:34 +09001943 switch (req_op(req)) {
1944 case REQ_OP_DISCARD:
Christoph Hellwig02d26102017-04-05 19:21:02 +02001945 case REQ_OP_WRITE_ZEROES:
Hannes Reinecke89d94752016-10-18 15:40:34 +09001946 case REQ_OP_WRITE_SAME:
1947 case REQ_OP_ZONE_RESET:
Martin K. Petersen26e85fc2012-09-18 12:19:31 -04001948 if (!result) {
1949 good_bytes = blk_rq_bytes(req);
1950 scsi_set_resid(SCpnt, 0);
1951 } else {
1952 good_bytes = 0;
1953 scsi_set_resid(SCpnt, blk_rq_bytes(req));
1954 }
Hannes Reinecke89d94752016-10-18 15:40:34 +09001955 break;
Damien Le Moalc46f0912017-03-01 17:27:00 +09001956 default:
1957 /*
1958 * In case of bogus fw or device, we could end up having
1959 * an unaligned partial completion. Check this here and force
1960 * alignment.
1961 */
1962 resid = scsi_get_resid(SCpnt);
1963 if (resid & (sector_size - 1)) {
1964 sd_printk(KERN_INFO, sdkp,
1965 "Unaligned partial completion (resid=%u, sector_sz=%u)\n",
1966 resid, sector_size);
1967 resid = min(scsi_bufflen(SCpnt),
1968 round_up(resid, sector_size));
1969 scsi_set_resid(SCpnt, resid);
1970 }
Martin K. Petersen26e85fc2012-09-18 12:19:31 -04001971 }
FUJITA Tomonori6a32a8a2010-07-21 10:29:37 +09001972
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 if (result) {
1974 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1975 if (sense_valid)
1976 sense_deferred = scsi_sense_is_deferred(&sshdr);
1977 }
David Jeffery2a863ba2014-04-10 11:08:30 -04001978 sdkp->medium_access_timed_out = 0;
1979
Luben Tuikov03aba2f2006-06-23 09:39:09 -07001980 if (driver_byte(result) != DRIVER_SENSE &&
1981 (!sense_valid || sense_deferred))
1982 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
Luben Tuikov03aba2f2006-06-23 09:39:09 -07001984 switch (sshdr.sense_key) {
1985 case HARDWARE_ERROR:
1986 case MEDIUM_ERROR:
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001987 good_bytes = sd_completed_bytes(SCpnt);
Luben Tuikov03aba2f2006-06-23 09:39:09 -07001988 break;
1989 case RECOVERED_ERROR:
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04001990 good_bytes = scsi_bufflen(SCpnt);
1991 break;
Jamie Wellnitz10dab222008-09-11 21:39:36 -04001992 case NO_SENSE:
1993 /* This indicates a false check condition, so ignore it. An
1994 * unknown amount of data was transferred so treat it as an
1995 * error.
1996 */
Jamie Wellnitz10dab222008-09-11 21:39:36 -04001997 SCpnt->result = 0;
1998 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1999 break;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002000 case ABORTED_COMMAND:
2001 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04002002 good_bytes = sd_completed_bytes(SCpnt);
Luben Tuikov03aba2f2006-06-23 09:39:09 -07002003 break;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002004 case ILLEGAL_REQUEST:
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002005 switch (sshdr.asc) {
2006 case 0x10: /* DIX: Host detected corruption */
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002007 good_bytes = sd_completed_bytes(SCpnt);
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002008 break;
2009 case 0x20: /* INVALID COMMAND OPCODE */
2010 case 0x24: /* INVALID FIELD IN CDB */
2011 switch (SCpnt->cmnd[0]) {
Martin K. Petersen5db44862012-09-18 12:19:32 -04002012 case UNMAP:
2013 sd_config_discard(sdkp, SD_LBP_DISABLE);
2014 break;
2015 case WRITE_SAME_16:
2016 case WRITE_SAME:
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002017 if (SCpnt->cmnd[1] & 8) { /* UNMAP */
Martin K. Petersen5db44862012-09-18 12:19:32 -04002018 sd_config_discard(sdkp, SD_LBP_DISABLE);
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002019 } else {
Martin K. Petersen5db44862012-09-18 12:19:32 -04002020 sdkp->device->no_write_same = 1;
2021 sd_config_write_same(sdkp);
Christoph Hellwige8064022016-10-20 15:12:13 +02002022 req->rq_flags |= RQF_QUIET;
Martin K. Petersen5db44862012-09-18 12:19:32 -04002023 }
Christoph Hellwigd227ec22017-04-24 19:05:12 -04002024 break;
Martin K. Petersen5db44862012-09-18 12:19:32 -04002025 }
2026 }
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002027 break;
Luben Tuikov03aba2f2006-06-23 09:39:09 -07002028 default:
2029 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 }
Hannes Reinecke89d94752016-10-18 15:40:34 +09002031
Luben Tuikov03aba2f2006-06-23 09:39:09 -07002032 out:
Hannes Reinecke89d94752016-10-18 15:40:34 +09002033 if (sd_is_zoned(sdkp))
2034 sd_zbc_complete(SCpnt, good_bytes, &sshdr);
2035
Hannes Reineckeef613292014-10-24 14:27:00 +02002036 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
2037 "sd_done: completed %d of %d bytes\n",
2038 good_bytes, scsi_bufflen(SCpnt)));
2039
Max Gurtovoy10c41dd2018-07-30 00:15:32 +03002040 if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt) &&
2041 good_bytes)
2042 t10_pi_complete(SCpnt->request, sdkp->protection_type,
2043 good_bytes / scsi_prot_interval(SCpnt));
Martin K. Petersenaf55ff62008-07-17 04:28:35 -04002044
Linus Torvalds7b3d9542008-01-06 10:17:12 -08002045 return good_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046}
2047
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048/*
2049 * spinup disk - called only in sd_revalidate_disk()
2050 */
2051static void
Martin K. Petersene73aec82007-02-27 22:40:55 -05002052sd_spinup_disk(struct scsi_disk *sdkp)
James Bottomleyea73a9f2005-08-28 11:33:52 -05002053{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 unsigned char cmd[10];
Alan Stern4451e472005-07-12 10:45:17 -04002055 unsigned long spintime_expire = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 int retries, spintime;
2057 unsigned int the_result;
2058 struct scsi_sense_hdr sshdr;
2059 int sense_valid = 0;
2060
2061 spintime = 0;
2062
2063 /* Spin up drives, as required. Only do this at boot time */
2064 /* Spinup needs to be done for module loads too. */
2065 do {
2066 retries = 0;
2067
2068 do {
2069 cmd[0] = TEST_UNIT_READY;
2070 memset((void *) &cmd[1], 0, 9);
2071
James Bottomleyea73a9f2005-08-28 11:33:52 -05002072 the_result = scsi_execute_req(sdkp->device, cmd,
2073 DMA_NONE, NULL, 0,
2074 &sshdr, SD_TIMEOUT,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002075 SD_MAX_RETRIES, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076
Alan Sternb4d38e32006-10-11 16:48:28 -04002077 /*
2078 * If the drive has indicated to us that it
2079 * doesn't have any media in it, don't bother
2080 * with any more polling.
2081 */
2082 if (media_not_present(sdkp, &sshdr))
2083 return;
2084
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 if (the_result)
James Bottomleyea73a9f2005-08-28 11:33:52 -05002086 sense_valid = scsi_sense_valid(&sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 retries++;
2088 } while (retries < 3 &&
2089 (!scsi_status_is_good(the_result) ||
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002090 ((driver_byte(the_result) == DRIVER_SENSE) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
2092
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002093 if (driver_byte(the_result) != DRIVER_SENSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 /* no sense, TUR either succeeded or failed
2095 * with a status error */
Martin K. Petersene73aec82007-02-27 22:40:55 -05002096 if(!spintime && !scsi_status_is_good(the_result)) {
Hannes Reineckeef613292014-10-24 14:27:00 +02002097 sd_print_result(sdkp, "Test Unit Ready failed",
2098 the_result);
Martin K. Petersene73aec82007-02-27 22:40:55 -05002099 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 break;
2101 }
Hannes Reineckeef613292014-10-24 14:27:00 +02002102
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 /*
2104 * The device does not want the automatic start to be issued.
2105 */
Matthew Wilcox33dd6f92009-02-20 06:53:48 -07002106 if (sdkp->device->no_start_on_add)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
Matthew Wilcox33dd6f92009-02-20 06:53:48 -07002109 if (sense_valid && sshdr.sense_key == NOT_READY) {
2110 if (sshdr.asc == 4 && sshdr.ascq == 3)
2111 break; /* manual intervention required */
2112 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
2113 break; /* standby */
2114 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
2115 break; /* unavailable */
Mahesh Rajashekhara505aa4b2018-04-17 17:03:12 +05302116 if (sshdr.asc == 4 && sshdr.ascq == 0x1b)
2117 break; /* sanitize in progress */
Matthew Wilcox33dd6f92009-02-20 06:53:48 -07002118 /*
2119 * Issue command to spin up drive when not ready
2120 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 if (!spintime) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05002122 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 cmd[0] = START_STOP;
2124 cmd[1] = 1; /* Return immediately */
2125 memset((void *) &cmd[2], 0, 8);
2126 cmd[4] = 1; /* Start spin cycle */
Stefan Richterd2886ea2008-05-11 00:34:07 +02002127 if (sdkp->device->start_stop_pwr_cond)
2128 cmd[4] |= 1 << 4;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002129 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
2130 NULL, 0, &sshdr,
FUJITA Tomonorif4f4e472008-12-04 14:24:39 +09002131 SD_TIMEOUT, SD_MAX_RETRIES,
2132 NULL);
Alan Stern4451e472005-07-12 10:45:17 -04002133 spintime_expire = jiffies + 100 * HZ;
2134 spintime = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 /* Wait 1 second for next try */
2137 msleep(1000);
Michał Mirosław3a1d0782017-11-24 18:02:35 +01002138 printk(KERN_CONT ".");
Alan Stern4451e472005-07-12 10:45:17 -04002139
2140 /*
2141 * Wait for USB flash devices with slow firmware.
2142 * Yes, this sense key/ASC combination shouldn't
2143 * occur here. It's characteristic of these devices.
2144 */
2145 } else if (sense_valid &&
2146 sshdr.sense_key == UNIT_ATTENTION &&
2147 sshdr.asc == 0x28) {
2148 if (!spintime) {
2149 spintime_expire = jiffies + 5 * HZ;
2150 spintime = 1;
2151 }
2152 /* Wait 1 second for next try */
2153 msleep(1000);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 } else {
2155 /* we don't understand the sense code, so it's
2156 * probably pointless to loop */
2157 if(!spintime) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05002158 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
2159 sd_print_sense_hdr(sdkp, &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 }
2161 break;
2162 }
2163
Alan Stern4451e472005-07-12 10:45:17 -04002164 } while (spintime && time_before_eq(jiffies, spintime_expire));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165
2166 if (spintime) {
2167 if (scsi_status_is_good(the_result))
Michał Mirosław3a1d0782017-11-24 18:02:35 +01002168 printk(KERN_CONT "ready\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 else
Michał Mirosław3a1d0782017-11-24 18:02:35 +01002170 printk(KERN_CONT "not responding...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 }
2172}
2173
Martin K. Petersene0597d72008-07-17 04:28:34 -04002174/*
2175 * Determine whether disk supports Data Integrity Field.
2176 */
Martin K. Petersenfe542392012-09-21 12:44:12 -04002177static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
Martin K. Petersene0597d72008-07-17 04:28:34 -04002178{
2179 struct scsi_device *sdp = sdkp->device;
2180 u8 type;
Martin K. Petersenfe542392012-09-21 12:44:12 -04002181 int ret = 0;
Martin K. Petersene0597d72008-07-17 04:28:34 -04002182
2183 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
Martin K. Petersenfe542392012-09-21 12:44:12 -04002184 return ret;
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -04002185
2186 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
2187
Christoph Hellwig8475c812016-09-11 19:35:41 +02002188 if (type > T10_PI_TYPE3_PROTECTION)
Martin K. Petersenfe542392012-09-21 12:44:12 -04002189 ret = -ENODEV;
2190 else if (scsi_host_dif_capable(sdp->host, type))
2191 ret = 1;
2192
2193 if (sdkp->first_scan || type != sdkp->protection_type)
2194 switch (ret) {
2195 case -ENODEV:
2196 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
2197 " protection type %u. Disabling disk!\n",
2198 type);
2199 break;
2200 case 1:
2201 sd_printk(KERN_NOTICE, sdkp,
2202 "Enabling DIF Type %u protection\n", type);
2203 break;
2204 case 0:
2205 sd_printk(KERN_NOTICE, sdkp,
2206 "Disabling DIF Type %u protection\n", type);
2207 break;
2208 }
Martin K. Petersene0597d72008-07-17 04:28:34 -04002209
Martin K. Petersenbe922f42008-09-19 18:47:20 -04002210 sdkp->protection_type = type;
2211
Martin K. Petersenfe542392012-09-21 12:44:12 -04002212 return ret;
Martin K. Petersene0597d72008-07-17 04:28:34 -04002213}
2214
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002215static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
2216 struct scsi_sense_hdr *sshdr, int sense_valid,
2217 int the_result)
2218{
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02002219 if (driver_byte(the_result) == DRIVER_SENSE)
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002220 sd_print_sense_hdr(sdkp, sshdr);
2221 else
2222 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
2223
2224 /*
2225 * Set dirty bit for removable devices if not ready -
2226 * sometimes drives will not report this properly.
2227 */
2228 if (sdp->removable &&
2229 sense_valid && sshdr->sense_key == NOT_READY)
Tejun Heo2bae0092010-12-18 18:42:23 +01002230 set_media_not_present(sdkp);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002231
2232 /*
2233 * We used to set media_present to 0 here to indicate no media
2234 * in the drive, but some drives fail read capacity even with
2235 * media present, so we can't do that.
2236 */
2237 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
2238}
2239
2240#define RC16_LEN 32
2241#if RC16_LEN > SD_BUF_SIZE
2242#error RC16_LEN must not be more than SD_BUF_SIZE
2243#endif
2244
James Bottomley3233ac12010-04-01 10:30:01 -04002245#define READ_CAPACITY_RETRIES_ON_RESET 10
2246
Martin K. Petersen7c856152017-04-04 10:42:30 -04002247/*
2248 * Ensure that we don't overflow sector_t when CONFIG_LBDAF is not set
2249 * and the reported logical block size is bigger than 512 bytes. Note
2250 * that last_sector is a u64 and therefore logical_to_sectors() is not
2251 * applicable.
2252 */
2253static bool sd_addressable_capacity(u64 lba, unsigned int sector_size)
2254{
2255 u64 last_sector = (lba + 1ULL) << (ilog2(sector_size) - 9);
2256
2257 if (sizeof(sector_t) == 4 && last_sector > U32_MAX)
2258 return false;
2259
2260 return true;
2261}
2262
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002263static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
2264 unsigned char *buffer)
James Bottomleyea73a9f2005-08-28 11:33:52 -05002265{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 unsigned char cmd[16];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 struct scsi_sense_hdr sshdr;
2268 int sense_valid = 0;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002269 int the_result;
James Bottomley3233ac12010-04-01 10:30:01 -04002270 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
Martin K. Petersenea09bcc2009-05-23 11:43:37 -04002271 unsigned int alignment;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002272 unsigned long long lba;
2273 unsigned sector_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274
Hans de Goede5ce524b2010-10-01 14:20:10 -07002275 if (sdp->no_read_capacity_16)
2276 return -EINVAL;
2277
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 do {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002279 memset(cmd, 0, 16);
Hannes Reineckeeb846d92014-11-17 14:25:19 +01002280 cmd[0] = SERVICE_ACTION_IN_16;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002281 cmd[1] = SAI_READ_CAPACITY_16;
2282 cmd[13] = RC16_LEN;
2283 memset(buffer, 0, RC16_LEN);
2284
James Bottomleyea73a9f2005-08-28 11:33:52 -05002285 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002286 buffer, RC16_LEN, &sshdr,
2287 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288
James Bottomleyea73a9f2005-08-28 11:33:52 -05002289 if (media_not_present(sdkp, &sshdr))
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002290 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291
Matthew Wilcox2b301302009-03-12 14:20:30 -04002292 if (the_result) {
James Bottomleyea73a9f2005-08-28 11:33:52 -05002293 sense_valid = scsi_sense_valid(&sshdr);
Matthew Wilcox2b301302009-03-12 14:20:30 -04002294 if (sense_valid &&
2295 sshdr.sense_key == ILLEGAL_REQUEST &&
2296 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
2297 sshdr.ascq == 0x00)
2298 /* Invalid Command Operation Code or
2299 * Invalid Field in CDB, just retry
2300 * silently with RC10 */
2301 return -EINVAL;
James Bottomley3233ac12010-04-01 10:30:01 -04002302 if (sense_valid &&
2303 sshdr.sense_key == UNIT_ATTENTION &&
2304 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2305 /* Device reset might occur several times,
2306 * give it one more chance */
2307 if (--reset_retries > 0)
2308 continue;
Matthew Wilcox2b301302009-03-12 14:20:30 -04002309 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 retries--;
2311
2312 } while (the_result && retries);
2313
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002314 if (the_result) {
Hannes Reineckeef613292014-10-24 14:27:00 +02002315 sd_print_result(sdkp, "Read Capacity(16) failed", the_result);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002316 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2317 return -EINVAL;
2318 }
Martin K. Petersene73aec82007-02-27 22:40:55 -05002319
Dave Hansen8f76d152009-04-21 16:43:27 -07002320 sector_size = get_unaligned_be32(&buffer[8]);
2321 lba = get_unaligned_be64(&buffer[0]);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002322
Martin K. Petersenfe542392012-09-21 12:44:12 -04002323 if (sd_read_protection_type(sdkp, buffer) < 0) {
2324 sdkp->capacity = 0;
2325 return -ENODEV;
2326 }
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002327
Martin K. Petersen7c856152017-04-04 10:42:30 -04002328 if (!sd_addressable_capacity(lba, sector_size)) {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002329 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2330 "kernel compiled with support for large block "
2331 "devices.\n");
2332 sdkp->capacity = 0;
2333 return -EOVERFLOW;
2334 }
2335
Martin K. Petersenea09bcc2009-05-23 11:43:37 -04002336 /* Logical blocks per physical block exponent */
Martin K. Petersen526f7c72010-09-28 14:48:47 -04002337 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
Martin K. Petersenea09bcc2009-05-23 11:43:37 -04002338
Hannes Reinecke89d94752016-10-18 15:40:34 +09002339 /* RC basis */
2340 sdkp->rc_basis = (buffer[12] >> 4) & 0x3;
2341
Martin K. Petersenea09bcc2009-05-23 11:43:37 -04002342 /* Lowest aligned logical block */
2343 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2344 blk_queue_alignment_offset(sdp->request_queue, alignment);
2345 if (alignment && sdkp->first_scan)
2346 sd_printk(KERN_NOTICE, sdkp,
2347 "physical block alignment offset: %u\n", alignment);
2348
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002349 if (buffer[14] & 0x80) { /* LBPME */
2350 sdkp->lbpme = 1;
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002351
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002352 if (buffer[14] & 0x40) /* LBPRZ */
2353 sdkp->lbprz = 1;
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002354
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002355 sd_config_discard(sdkp, SD_LBP_WS16);
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002356 }
2357
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002358 sdkp->capacity = lba + 1;
2359 return sector_size;
2360}
2361
2362static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2363 unsigned char *buffer)
2364{
2365 unsigned char cmd[16];
2366 struct scsi_sense_hdr sshdr;
2367 int sense_valid = 0;
2368 int the_result;
James Bottomley3233ac12010-04-01 10:30:01 -04002369 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002370 sector_t lba;
2371 unsigned sector_size;
2372
2373 do {
2374 cmd[0] = READ_CAPACITY;
2375 memset(&cmd[1], 0, 9);
2376 memset(buffer, 0, 8);
2377
2378 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2379 buffer, 8, &sshdr,
2380 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2381
2382 if (media_not_present(sdkp, &sshdr))
2383 return -ENODEV;
2384
James Bottomley3233ac12010-04-01 10:30:01 -04002385 if (the_result) {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002386 sense_valid = scsi_sense_valid(&sshdr);
James Bottomley3233ac12010-04-01 10:30:01 -04002387 if (sense_valid &&
2388 sshdr.sense_key == UNIT_ATTENTION &&
2389 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2390 /* Device reset might occur several times,
2391 * give it one more chance */
2392 if (--reset_retries > 0)
2393 continue;
2394 }
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002395 retries--;
2396
2397 } while (the_result && retries);
2398
2399 if (the_result) {
Hannes Reineckeef613292014-10-24 14:27:00 +02002400 sd_print_result(sdkp, "Read Capacity(10) failed", the_result);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002401 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2402 return -EINVAL;
2403 }
2404
Dave Hansen8f76d152009-04-21 16:43:27 -07002405 sector_size = get_unaligned_be32(&buffer[4]);
2406 lba = get_unaligned_be32(&buffer[0]);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002407
Hans de Goede5ce524b2010-10-01 14:20:10 -07002408 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2409 /* Some buggy (usb cardreader) devices return an lba of
2410 0xffffffff when the want to report a size of 0 (with
2411 which they really mean no media is present) */
2412 sdkp->capacity = 0;
Linus Torvalds5cc10352010-10-22 20:30:48 -07002413 sdkp->physical_block_size = sector_size;
Hans de Goede5ce524b2010-10-01 14:20:10 -07002414 return sector_size;
2415 }
2416
Martin K. Petersen7c856152017-04-04 10:42:30 -04002417 if (!sd_addressable_capacity(lba, sector_size)) {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002418 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2419 "kernel compiled with support for large block "
2420 "devices.\n");
2421 sdkp->capacity = 0;
2422 return -EOVERFLOW;
2423 }
2424
2425 sdkp->capacity = lba + 1;
Martin K. Petersen526f7c72010-09-28 14:48:47 -04002426 sdkp->physical_block_size = sector_size;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002427 return sector_size;
2428}
2429
Matthew Wilcox2b301302009-03-12 14:20:30 -04002430static int sd_try_rc16_first(struct scsi_device *sdp)
2431{
Hannes Reineckef87146b2010-03-29 09:29:24 +02002432 if (sdp->host->max_cmd_len < 16)
2433 return 0;
Alan Stern6a0bdff2012-06-20 16:04:19 -04002434 if (sdp->try_rc_10_first)
2435 return 0;
Matthew Wilcox2b301302009-03-12 14:20:30 -04002436 if (sdp->scsi_level > SCSI_SPC_2)
2437 return 1;
2438 if (scsi_device_protection(sdp))
2439 return 1;
2440 return 0;
2441}
2442
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002443/*
2444 * read disk capacity
2445 */
2446static void
2447sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2448{
2449 int sector_size;
2450 struct scsi_device *sdp = sdkp->device;
2451
Matthew Wilcox2b301302009-03-12 14:20:30 -04002452 if (sd_try_rc16_first(sdp)) {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002453 sector_size = read_capacity_16(sdkp, sdp, buffer);
2454 if (sector_size == -EOVERFLOW)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 goto got_data;
Matthew Wilcox2b301302009-03-12 14:20:30 -04002456 if (sector_size == -ENODEV)
2457 return;
2458 if (sector_size < 0)
2459 sector_size = read_capacity_10(sdkp, sdp, buffer);
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002460 if (sector_size < 0)
2461 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 } else {
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002463 sector_size = read_capacity_10(sdkp, sdp, buffer);
2464 if (sector_size == -EOVERFLOW)
2465 goto got_data;
2466 if (sector_size < 0)
2467 return;
2468 if ((sizeof(sdkp->capacity) > 4) &&
2469 (sdkp->capacity > 0xffffffffULL)) {
2470 int old_sector_size = sector_size;
2471 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2472 "Trying to use READ CAPACITY(16).\n");
2473 sector_size = read_capacity_16(sdkp, sdp, buffer);
2474 if (sector_size < 0) {
2475 sd_printk(KERN_NOTICE, sdkp,
2476 "Using 0xffffffff as device size\n");
2477 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2478 sector_size = old_sector_size;
2479 goto got_data;
2480 }
Martin K. Petersen597d7402018-03-14 12:15:56 -04002481 /* Remember that READ CAPACITY(16) succeeded */
2482 sdp->try_rc_10_first = 0;
Matthew Wilcox0da205e2009-03-12 14:20:29 -04002483 }
2484 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485
Alan Stern5c211ca2009-02-18 10:54:44 -05002486 /* Some devices are known to return the total number of blocks,
2487 * not the highest block number. Some devices have versions
2488 * which do this and others which do not. Some devices we might
2489 * suspect of doing this but we don't know for certain.
2490 *
2491 * If we know the reported capacity is wrong, decrement it. If
2492 * we can only guess, then assume the number of blocks is even
2493 * (usually true but not always) and err on the side of lowering
2494 * the capacity.
2495 */
2496 if (sdp->fix_capacity ||
2497 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2498 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2499 "from its reported value: %llu\n",
2500 (unsigned long long) sdkp->capacity);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 --sdkp->capacity;
Oliver Neukum61bf54b2007-02-08 09:04:48 +01002502 }
2503
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504got_data:
2505 if (sector_size == 0) {
2506 sector_size = 512;
Martin K. Petersene73aec82007-02-27 22:40:55 -05002507 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2508 "assuming 512.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509 }
2510
2511 if (sector_size != 512 &&
2512 sector_size != 1024 &&
2513 sector_size != 2048 &&
Mark Hounschell74856fb2015-05-13 10:49:09 +02002514 sector_size != 4096) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05002515 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2516 sector_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 /*
2518 * The user might want to re-format the drive with
2519 * a supported sectorsize. Once this happens, it
2520 * would be relatively trivial to set the thing up.
2521 * For this reason, we leave the thing in the table.
2522 */
2523 sdkp->capacity = 0;
2524 /*
2525 * set a bogus sector size so the normal read/write
2526 * logic in the block layer will eventually refuse any
2527 * request on this device without tripping over power
2528 * of two sector size assumptions
2529 */
2530 sector_size = 512;
2531 }
Martin K. Petersene1defc42009-05-22 17:17:49 -04002532 blk_queue_logical_block_size(sdp->request_queue, sector_size);
Hannes Reinecke89d94752016-10-18 15:40:34 +09002533 blk_queue_physical_block_size(sdp->request_queue,
2534 sdkp->physical_block_size);
2535 sdkp->device->sector_size = sector_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536
Martin K. Petersenca369d52015-11-13 16:46:48 -05002537 if (sdkp->capacity > 0xffffffff)
Martin K. Petersenbcdb2472014-06-03 18:45:51 -04002538 sdp->use_16_for_rw = 1;
Jason J. Herne53ad5702012-11-14 17:03:22 -05002539
Hannes Reinecke89d94752016-10-18 15:40:34 +09002540}
2541
2542/*
2543 * Print disk capacity
2544 */
2545static void
2546sd_print_capacity(struct scsi_disk *sdkp,
2547 sector_t old_capacity)
2548{
2549 int sector_size = sdkp->device->sector_size;
2550 char cap_str_2[10], cap_str_10[10];
2551
2552 string_get_size(sdkp->capacity, sector_size,
2553 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
2554 string_get_size(sdkp->capacity, sector_size,
2555 STRING_UNITS_10, cap_str_10,
2556 sizeof(cap_str_10));
2557
2558 if (sdkp->first_scan || old_capacity != sdkp->capacity) {
2559 sd_printk(KERN_NOTICE, sdkp,
2560 "%llu %d-byte logical blocks: (%s/%s)\n",
2561 (unsigned long long)sdkp->capacity,
2562 sector_size, cap_str_10, cap_str_2);
2563
2564 if (sdkp->physical_block_size != sector_size)
2565 sd_printk(KERN_NOTICE, sdkp,
2566 "%u-byte physical blocks\n",
2567 sdkp->physical_block_size);
2568
2569 sd_zbc_print_zones(sdkp);
2570 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571}
2572
2573/* called with buffer of length 512 */
2574static inline int
James Bottomleyea73a9f2005-08-28 11:33:52 -05002575sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
2576 unsigned char *buffer, int len, struct scsi_mode_data *data,
2577 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578{
James Bottomleyea73a9f2005-08-28 11:33:52 -05002579 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
James Bottomley1cf72692005-08-28 11:27:01 -05002580 SD_TIMEOUT, SD_MAX_RETRIES, data,
James Bottomleyea73a9f2005-08-28 11:33:52 -05002581 sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582}
2583
2584/*
2585 * read write protect setting, if possible - called only in sd_revalidate_disk()
Al Viro48970802006-02-26 08:34:10 -06002586 * called with buffer of length SD_BUF_SIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587 */
2588static void
Martin K. Petersene73aec82007-02-27 22:40:55 -05002589sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
James Bottomleyea73a9f2005-08-28 11:33:52 -05002590{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 int res;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002592 struct scsi_device *sdp = sdkp->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 struct scsi_mode_data data;
Jeremy Cline20bd1d02018-03-06 21:47:32 +00002594 int disk_ro = get_disk_ro(sdkp->disk);
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002595 int old_wp = sdkp->write_prot;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596
2597 set_disk_ro(sdkp->disk, 0);
James Bottomleyea73a9f2005-08-28 11:33:52 -05002598 if (sdp->skip_ms_page_3f) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002599 sd_first_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 return;
2601 }
2602
James Bottomleyea73a9f2005-08-28 11:33:52 -05002603 if (sdp->use_192_bytes_for_3f) {
2604 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 } else {
2606 /*
2607 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2608 * We have to start carefully: some devices hang if we ask
2609 * for more than is available.
2610 */
James Bottomleyea73a9f2005-08-28 11:33:52 -05002611 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612
2613 /*
2614 * Second attempt: ask for page 0 When only page 0 is
2615 * implemented, a request for page 3F may return Sense Key
2616 * 5: Illegal Request, Sense Code 24: Invalid field in
2617 * CDB.
2618 */
2619 if (!scsi_status_is_good(res))
James Bottomleyea73a9f2005-08-28 11:33:52 -05002620 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621
2622 /*
2623 * Third attempt: ask 255 bytes, as we did earlier.
2624 */
2625 if (!scsi_status_is_good(res))
James Bottomleyea73a9f2005-08-28 11:33:52 -05002626 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
2627 &data, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628 }
2629
2630 if (!scsi_status_is_good(res)) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002631 sd_first_printk(KERN_WARNING, sdkp,
Martin K. Petersene73aec82007-02-27 22:40:55 -05002632 "Test WP failed, assume Write Enabled\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 } else {
2634 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
Jeremy Cline20bd1d02018-03-06 21:47:32 +00002635 set_disk_ro(sdkp->disk, sdkp->write_prot || disk_ro);
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002636 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2637 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2638 sdkp->write_prot ? "on" : "off");
Andy Shevchenkodf441cc2016-10-22 20:32:30 +03002639 sd_printk(KERN_DEBUG, sdkp, "Mode Sense: %4ph\n", buffer);
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002640 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641 }
2642}
2643
2644/*
2645 * sd_read_cache_type - called only from sd_revalidate_disk()
Al Viro48970802006-02-26 08:34:10 -06002646 * called with buffer of length SD_BUF_SIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 */
2648static void
Martin K. Petersene73aec82007-02-27 22:40:55 -05002649sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
Al Viro 631e8a12005-05-16 01:59:55 +01002650{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 int len = 0, res;
James Bottomleyea73a9f2005-08-28 11:33:52 -05002652 struct scsi_device *sdp = sdkp->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653
Al Viro 631e8a12005-05-16 01:59:55 +01002654 int dbd;
2655 int modepage;
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002656 int first_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657 struct scsi_mode_data data;
2658 struct scsi_sense_hdr sshdr;
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002659 int old_wce = sdkp->WCE;
2660 int old_rcd = sdkp->RCD;
2661 int old_dpofua = sdkp->DPOFUA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662
James Bottomley39c60a02013-04-24 14:02:53 -07002663
2664 if (sdkp->cache_override)
2665 return;
2666
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002667 first_len = 4;
2668 if (sdp->skip_ms_page_8) {
2669 if (sdp->type == TYPE_RBC)
2670 goto defaults;
2671 else {
2672 if (sdp->skip_ms_page_3f)
2673 goto defaults;
2674 modepage = 0x3F;
2675 if (sdp->use_192_bytes_for_3f)
2676 first_len = 192;
2677 dbd = 0;
2678 }
2679 } else if (sdp->type == TYPE_RBC) {
Al Viro 631e8a12005-05-16 01:59:55 +01002680 modepage = 6;
2681 dbd = 8;
2682 } else {
2683 modepage = 8;
2684 dbd = 0;
2685 }
2686
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 /* cautiously ask */
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002688 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2689 &data, &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690
2691 if (!scsi_status_is_good(res))
2692 goto bad_sense;
2693
Al Viro6d73c852006-02-23 02:03:16 +01002694 if (!data.header_length) {
2695 modepage = 6;
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002696 first_len = 0;
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002697 sd_first_printk(KERN_ERR, sdkp,
2698 "Missing header in MODE_SENSE response\n");
Al Viro6d73c852006-02-23 02:03:16 +01002699 }
2700
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701 /* that went OK, now ask for the proper length */
2702 len = data.length;
2703
2704 /*
2705 * We're only interested in the first three bytes, actually.
2706 * But the data cache page is defined for the first 20.
2707 */
2708 if (len < 3)
2709 goto bad_sense;
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002710 else if (len > SD_BUF_SIZE) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002711 sd_first_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002712 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2713 len = SD_BUF_SIZE;
2714 }
2715 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2716 len = 192;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717
2718 /* Get the data */
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002719 if (len > first_len)
2720 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2721 &data, &sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722
2723 if (scsi_status_is_good(res)) {
Al Viro 631e8a12005-05-16 01:59:55 +01002724 int offset = data.header_length + data.block_descriptor_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002726 while (offset < len) {
2727 u8 page_code = buffer[offset] & 0x3F;
2728 u8 spf = buffer[offset] & 0x40;
2729
2730 if (page_code == 8 || page_code == 6) {
2731 /* We're interested only in the first 3 bytes.
2732 */
2733 if (len - offset <= 2) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002734 sd_first_printk(KERN_ERR, sdkp,
2735 "Incomplete mode parameter "
2736 "data\n");
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002737 goto defaults;
2738 } else {
2739 modepage = page_code;
2740 goto Page_found;
2741 }
2742 } else {
2743 /* Go to the next page */
2744 if (spf && len - offset > 3)
2745 offset += 4 + (buffer[offset+2] << 8) +
2746 buffer[offset+3];
2747 else if (!spf && len - offset > 1)
2748 offset += 2 + buffer[offset+1];
2749 else {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002750 sd_first_printk(KERN_ERR, sdkp,
2751 "Incomplete mode "
2752 "parameter data\n");
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002753 goto defaults;
2754 }
2755 }
Al Viro48970802006-02-26 08:34:10 -06002756 }
2757
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002758 sd_first_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
Alan Stern984f1732013-09-06 11:49:51 -04002759 goto defaults;
2760
Luben Tuikov0bcaa112011-05-19 00:00:58 -07002761 Page_found:
Al Viro 631e8a12005-05-16 01:59:55 +01002762 if (modepage == 8) {
2763 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2764 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2765 } else {
2766 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2767 sdkp->RCD = 0;
2768 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769
Tejun Heo007365a2006-01-06 09:53:52 +01002770 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
Alan Sternb14bf2d2014-06-30 11:04:21 -04002771 if (sdp->broken_fua) {
2772 sd_first_printk(KERN_NOTICE, sdkp, "Disabling FUA\n");
2773 sdkp->DPOFUA = 0;
Damien Le Moal26f28192017-01-12 15:25:10 +09002774 } else if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw &&
2775 !sdkp->device->use_16_for_rw) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002776 sd_first_printk(KERN_NOTICE, sdkp,
Martin K. Petersene73aec82007-02-27 22:40:55 -05002777 "Uses READ/WRITE(6), disabling FUA\n");
Tejun Heo007365a2006-01-06 09:53:52 +01002778 sdkp->DPOFUA = 0;
2779 }
2780
Sujit Reddy Thumma2eefd572014-08-11 15:40:37 +03002781 /* No cache flush allowed for write protected devices */
2782 if (sdkp->WCE && sdkp->write_prot)
2783 sdkp->WCE = 0;
2784
Martin K. Petersen70a9b872009-03-09 11:33:31 -04002785 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2786 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2787 sd_printk(KERN_NOTICE, sdkp,
2788 "Write cache: %s, read cache: %s, %s\n",
2789 sdkp->WCE ? "enabled" : "disabled",
2790 sdkp->RCD ? "disabled" : "enabled",
2791 sdkp->DPOFUA ? "supports DPO and FUA"
2792 : "doesn't support DPO or FUA");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793
2794 return;
2795 }
2796
2797bad_sense:
James Bottomleyea73a9f2005-08-28 11:33:52 -05002798 if (scsi_sense_valid(&sshdr) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799 sshdr.sense_key == ILLEGAL_REQUEST &&
2800 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
Martin K. Petersene73aec82007-02-27 22:40:55 -05002801 /* Invalid field in CDB */
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002802 sd_first_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803 else
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002804 sd_first_printk(KERN_ERR, sdkp,
2805 "Asking for cache data failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806
2807defaults:
Namjae Jeonb81478d2012-07-07 23:05:08 -04002808 if (sdp->wce_default_on) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002809 sd_first_printk(KERN_NOTICE, sdkp,
2810 "Assuming drive cache: write back\n");
Namjae Jeonb81478d2012-07-07 23:05:08 -04002811 sdkp->WCE = 1;
2812 } else {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002813 sd_first_printk(KERN_ERR, sdkp,
2814 "Assuming drive cache: write through\n");
Namjae Jeonb81478d2012-07-07 23:05:08 -04002815 sdkp->WCE = 0;
2816 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817 sdkp->RCD = 0;
Al Viro48970802006-02-26 08:34:10 -06002818 sdkp->DPOFUA = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819}
2820
Martin K. Petersene0597d72008-07-17 04:28:34 -04002821/*
2822 * The ATO bit indicates whether the DIF application tag is available
2823 * for use by the operating system.
2824 */
H Hartley Sweeten439d77f2010-08-10 18:01:20 -07002825static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
Martin K. Petersene0597d72008-07-17 04:28:34 -04002826{
2827 int res, offset;
2828 struct scsi_device *sdp = sdkp->device;
2829 struct scsi_mode_data data;
2830 struct scsi_sense_hdr sshdr;
2831
Hannes Reinecke89d94752016-10-18 15:40:34 +09002832 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
Martin K. Petersene0597d72008-07-17 04:28:34 -04002833 return;
2834
2835 if (sdkp->protection_type == 0)
2836 return;
2837
2838 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2839 SD_MAX_RETRIES, &data, &sshdr);
2840
2841 if (!scsi_status_is_good(res) || !data.header_length ||
2842 data.length < 6) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002843 sd_first_printk(KERN_WARNING, sdkp,
Martin K. Petersene0597d72008-07-17 04:28:34 -04002844 "getting Control mode page failed, assume no ATO\n");
2845
2846 if (scsi_sense_valid(&sshdr))
2847 sd_print_sense_hdr(sdkp, &sshdr);
2848
2849 return;
2850 }
2851
2852 offset = data.header_length + data.block_descriptor_length;
2853
2854 if ((buffer[offset] & 0x3f) != 0x0a) {
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -05002855 sd_first_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
Martin K. Petersene0597d72008-07-17 04:28:34 -04002856 return;
2857 }
2858
2859 if ((buffer[offset + 5] & 0x80) == 0)
2860 return;
2861
2862 sdkp->ATO = 1;
2863
2864 return;
2865}
2866
Linus Torvalds1da177e2005-04-16 15:20:36 -07002867/**
Martin K. Petersend11b6912009-05-23 11:43:39 -04002868 * sd_read_block_limits - Query disk device for preferred I/O sizes.
Damien Le Moal7529fbb2017-04-24 16:51:09 +09002869 * @sdkp: disk to query
Martin K. Petersend11b6912009-05-23 11:43:39 -04002870 */
2871static void sd_read_block_limits(struct scsi_disk *sdkp)
2872{
2873 unsigned int sector_sz = sdkp->device->sector_size;
Martin K. Petersenbb2d3de2010-03-02 08:44:34 -05002874 const int vpd_len = 64;
James Bottomleye3deec02009-11-03 12:33:07 -06002875 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
Martin K. Petersend11b6912009-05-23 11:43:39 -04002876
James Bottomleye3deec02009-11-03 12:33:07 -06002877 if (!buffer ||
2878 /* Block Limits VPD */
2879 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2880 goto out;
Martin K. Petersend11b6912009-05-23 11:43:39 -04002881
2882 blk_queue_io_min(sdkp->disk->queue,
2883 get_unaligned_be16(&buffer[6]) * sector_sz);
Martin K. Petersenca369d52015-11-13 16:46:48 -05002884
2885 sdkp->max_xfer_blocks = get_unaligned_be32(&buffer[8]);
2886 sdkp->opt_xfer_blocks = get_unaligned_be32(&buffer[12]);
Martin K. Petersend11b6912009-05-23 11:43:39 -04002887
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002888 if (buffer[3] == 0x3c) {
2889 unsigned int lba_count, desc_count;
2890
Martin K. Petersen5db44862012-09-18 12:19:32 -04002891 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002892
2893 if (!sdkp->lbpme)
2894 goto out;
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002895
2896 lba_count = get_unaligned_be32(&buffer[20]);
2897 desc_count = get_unaligned_be32(&buffer[24]);
2898
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002899 if (lba_count && desc_count)
2900 sdkp->max_unmap_blocks = lba_count;
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002901
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002902 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002903
2904 if (buffer[32] & 0x80)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002905 sdkp->unmap_alignment =
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002906 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002907
2908 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2909
2910 if (sdkp->max_unmap_blocks)
2911 sd_config_discard(sdkp, SD_LBP_UNMAP);
2912 else
2913 sd_config_discard(sdkp, SD_LBP_WS16);
2914
2915 } else { /* LBP VPD page tells us what to use */
Martin K. Petersenbcd069b2017-04-05 19:21:25 +02002916 if (sdkp->lbpu && sdkp->max_unmap_blocks)
Martin K. Petersene4613382014-12-05 08:58:03 -05002917 sd_config_discard(sdkp, SD_LBP_UNMAP);
2918 else if (sdkp->lbpws)
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002919 sd_config_discard(sdkp, SD_LBP_WS16);
2920 else if (sdkp->lbpws10)
2921 sd_config_discard(sdkp, SD_LBP_WS10);
2922 else
2923 sd_config_discard(sdkp, SD_LBP_DISABLE);
2924 }
Martin K. Petersene339c1a2009-11-26 12:00:40 -05002925 }
2926
James Bottomleye3deec02009-11-03 12:33:07 -06002927 out:
Martin K. Petersend11b6912009-05-23 11:43:39 -04002928 kfree(buffer);
2929}
2930
2931/**
Martin K. Petersen3821d762009-05-23 11:43:38 -04002932 * sd_read_block_characteristics - Query block dev. characteristics
Damien Le Moal7529fbb2017-04-24 16:51:09 +09002933 * @sdkp: disk to query
Martin K. Petersen3821d762009-05-23 11:43:38 -04002934 */
2935static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2936{
Hannes Reinecke89d94752016-10-18 15:40:34 +09002937 struct request_queue *q = sdkp->disk->queue;
James Bottomleye3deec02009-11-03 12:33:07 -06002938 unsigned char *buffer;
Martin K. Petersen3821d762009-05-23 11:43:38 -04002939 u16 rot;
Martin K. Petersenbb2d3de2010-03-02 08:44:34 -05002940 const int vpd_len = 64;
Martin K. Petersen3821d762009-05-23 11:43:38 -04002941
James Bottomleye3deec02009-11-03 12:33:07 -06002942 buffer = kmalloc(vpd_len, GFP_KERNEL);
Martin K. Petersen3821d762009-05-23 11:43:38 -04002943
James Bottomleye3deec02009-11-03 12:33:07 -06002944 if (!buffer ||
2945 /* Block Device Characteristics VPD */
2946 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2947 goto out;
Martin K. Petersen3821d762009-05-23 11:43:38 -04002948
2949 rot = get_unaligned_be16(&buffer[4]);
2950
Mike Snitzerb277da02014-10-04 10:55:32 -06002951 if (rot == 1) {
Bart Van Assche8b904b52018-03-07 17:10:10 -08002952 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
2953 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, q);
Xuewei Zhang83e32a52018-09-06 13:37:19 -07002954 } else {
2955 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
2956 blk_queue_flag_set(QUEUE_FLAG_ADD_RANDOM, q);
Mike Snitzerb277da02014-10-04 10:55:32 -06002957 }
Martin K. Petersen3821d762009-05-23 11:43:38 -04002958
Damien Le Moal68af4122017-01-12 15:25:11 +09002959 if (sdkp->device->type == TYPE_ZBC) {
2960 /* Host-managed */
Hannes Reinecke89d94752016-10-18 15:40:34 +09002961 q->limits.zoned = BLK_ZONED_HM;
Damien Le Moal68af4122017-01-12 15:25:11 +09002962 } else {
2963 sdkp->zoned = (buffer[8] >> 4) & 3;
2964 if (sdkp->zoned == 1)
2965 /* Host-aware */
2966 q->limits.zoned = BLK_ZONED_HA;
2967 else
2968 /*
2969 * Treat drive-managed devices as
2970 * regular block devices.
2971 */
2972 q->limits.zoned = BLK_ZONED_NONE;
2973 }
Hannes Reinecke89d94752016-10-18 15:40:34 +09002974 if (blk_queue_is_zoned(q) && sdkp->first_scan)
2975 sd_printk(KERN_NOTICE, sdkp, "Host-%s zoned block device\n",
2976 q->limits.zoned == BLK_ZONED_HM ? "managed" : "aware");
2977
James Bottomleye3deec02009-11-03 12:33:07 -06002978 out:
Martin K. Petersen3821d762009-05-23 11:43:38 -04002979 kfree(buffer);
2980}
2981
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002982/**
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002983 * sd_read_block_provisioning - Query provisioning VPD page
Damien Le Moal7529fbb2017-04-24 16:51:09 +09002984 * @sdkp: disk to query
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002985 */
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002986static void sd_read_block_provisioning(struct scsi_disk *sdkp)
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002987{
2988 unsigned char *buffer;
2989 const int vpd_len = 8;
2990
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002991 if (sdkp->lbpme == 0)
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04002992 return;
2993
2994 buffer = kmalloc(vpd_len, GFP_KERNEL);
2995
2996 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
2997 goto out;
2998
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05002999 sdkp->lbpvpd = 1;
3000 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
3001 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
3002 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
Martin K. Petersen045d3fe2010-09-10 01:22:07 -04003003
3004 out:
3005 kfree(buffer);
3006}
3007
Martin K. Petersen5db44862012-09-18 12:19:32 -04003008static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
3009{
Martin K. Petersen66c28f92013-06-06 22:15:55 -04003010 struct scsi_device *sdev = sdkp->device;
3011
Martin K. Petersen54b2b502013-10-23 06:25:40 -04003012 if (sdev->host->no_write_same) {
3013 sdev->no_write_same = 1;
3014
3015 return;
3016 }
3017
Martin K. Petersen66c28f92013-06-06 22:15:55 -04003018 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
Bernd Schubertaf736232013-09-23 14:47:32 +02003019 /* too large values might cause issues with arcmsr */
3020 int vpd_buf_len = 64;
3021
Martin K. Petersen66c28f92013-06-06 22:15:55 -04003022 sdev->no_report_opcodes = 1;
3023
3024 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
3025 * CODES is unsupported and the device has an ATA
3026 * Information VPD page (SAT).
3027 */
Bernd Schubertaf736232013-09-23 14:47:32 +02003028 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
Martin K. Petersen66c28f92013-06-06 22:15:55 -04003029 sdev->no_write_same = 1;
3030 }
3031
3032 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
Martin K. Petersen5db44862012-09-18 12:19:32 -04003033 sdkp->ws16 = 1;
Martin K. Petersen66c28f92013-06-06 22:15:55 -04003034
3035 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
3036 sdkp->ws10 = 1;
Martin K. Petersen5db44862012-09-18 12:19:32 -04003037}
3038
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003039static void sd_read_security(struct scsi_disk *sdkp, unsigned char *buffer)
3040{
3041 struct scsi_device *sdev = sdkp->device;
3042
3043 if (!sdev->security_supported)
3044 return;
3045
3046 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3047 SECURITY_PROTOCOL_IN) == 1 &&
3048 scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3049 SECURITY_PROTOCOL_OUT) == 1)
3050 sdkp->security = 1;
3051}
3052
Martin K. Petersen3821d762009-05-23 11:43:38 -04003053/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07003054 * sd_revalidate_disk - called the first time a new disk is seen,
3055 * performs disk spin up, read_capacity, etc.
3056 * @disk: struct gendisk we care about
3057 **/
3058static int sd_revalidate_disk(struct gendisk *disk)
3059{
3060 struct scsi_disk *sdkp = scsi_disk(disk);
3061 struct scsi_device *sdp = sdkp->device;
Martin K. Petersenca369d52015-11-13 16:46:48 -05003062 struct request_queue *q = sdkp->disk->queue;
Hannes Reinecke89d94752016-10-18 15:40:34 +09003063 sector_t old_capacity = sdkp->capacity;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 unsigned char *buffer;
Martin K. Petersenca369d52015-11-13 16:46:48 -05003065 unsigned int dev_max, rw_max;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066
Martin K. Petersenfa0d34b2007-02-27 22:41:19 -05003067 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
3068 "sd_revalidate_disk\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003069
3070 /*
3071 * If the device is offline, don't try and read capacity or any
3072 * of the other niceties.
3073 */
3074 if (!scsi_device_online(sdp))
3075 goto out;
3076
Bernhard Wallea6123f12007-05-21 17:15:26 +02003077 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003078 if (!buffer) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05003079 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
3080 "allocation failure.\n");
James Bottomleyea73a9f2005-08-28 11:33:52 -05003081 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082 }
3083
Martin K. Petersene73aec82007-02-27 22:40:55 -05003084 sd_spinup_disk(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085
3086 /*
3087 * Without media there is no reason to ask; moreover, some devices
3088 * react badly if we do.
3089 */
3090 if (sdkp->media_present) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05003091 sd_read_capacity(sdkp, buffer);
Martin K. Petersenffd4bc22009-07-29 14:06:53 -04003092
Hannes Reinecke5ddfe082016-04-01 08:57:36 +02003093 if (scsi_device_supports_vpd(sdp)) {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -05003094 sd_read_block_provisioning(sdkp);
Martin K. Petersenffd4bc22009-07-29 14:06:53 -04003095 sd_read_block_limits(sdkp);
3096 sd_read_block_characteristics(sdkp);
Hannes Reinecke89d94752016-10-18 15:40:34 +09003097 sd_zbc_read_zones(sdkp, buffer);
Martin K. Petersenffd4bc22009-07-29 14:06:53 -04003098 }
3099
Hannes Reinecke89d94752016-10-18 15:40:34 +09003100 sd_print_capacity(sdkp, old_capacity);
3101
Martin K. Petersene73aec82007-02-27 22:40:55 -05003102 sd_read_write_protect_flag(sdkp, buffer);
3103 sd_read_cache_type(sdkp, buffer);
Martin K. Petersene0597d72008-07-17 04:28:34 -04003104 sd_read_app_tag_own(sdkp, buffer);
Martin K. Petersen5db44862012-09-18 12:19:32 -04003105 sd_read_write_same(sdkp, buffer);
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003106 sd_read_security(sdkp, buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003107 }
Tejun Heo461d4e92006-01-06 09:52:55 +01003108
3109 /*
3110 * We now have all cache related info, determine how we deal
Tejun Heo4913efe2010-09-03 11:56:16 +02003111 * with flush requests.
Tejun Heo461d4e92006-01-06 09:52:55 +01003112 */
Vaughan Caocb2fb682014-06-03 17:37:30 +08003113 sd_set_flush_flag(sdkp);
Tejun Heo461d4e92006-01-06 09:52:55 +01003114
Martin K. Petersenca369d52015-11-13 16:46:48 -05003115 /* Initial block count limit based on CDB TRANSFER LENGTH field size. */
3116 dev_max = sdp->use_16_for_rw ? SD_MAX_XFER_BLOCKS : SD_DEF_XFER_BLOCKS;
Brian King3a9794d2015-01-29 15:54:40 -06003117
Martin K. Petersenca369d52015-11-13 16:46:48 -05003118 /* Some devices report a maximum block count for READ/WRITE requests. */
3119 dev_max = min_not_zero(dev_max, sdkp->max_xfer_blocks);
3120 q->limits.max_dev_sectors = logical_to_sectors(sdp, dev_max);
3121
3122 /*
Martin K. Petersen77082ca2017-09-27 21:38:59 -04003123 * Determine the device's preferred I/O size for reads and writes
Martin K. Petersen9c1d9c22015-12-16 17:53:52 -05003124 * unless the reported value is unreasonably small, large, or
3125 * garbage.
Martin K. Petersenca369d52015-11-13 16:46:48 -05003126 */
Martin K. Petersen9c1d9c22015-12-16 17:53:52 -05003127 if (sdkp->opt_xfer_blocks &&
3128 sdkp->opt_xfer_blocks <= dev_max &&
3129 sdkp->opt_xfer_blocks <= SD_DEF_XFER_BLOCKS &&
Martin K. Petersen6b7e9cd2016-05-12 22:17:34 -04003130 logical_to_bytes(sdp, sdkp->opt_xfer_blocks) >= PAGE_SIZE) {
3131 q->limits.io_opt = logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3132 rw_max = logical_to_sectors(sdp, sdkp->opt_xfer_blocks);
3133 } else
Fam Zheng67804142017-03-28 12:41:26 +08003134 rw_max = min_not_zero(logical_to_sectors(sdp, dev_max),
3135 (sector_t)BLK_DEF_MAX_SECTORS);
Martin K. Petersenca369d52015-11-13 16:46:48 -05003136
Martin K. Petersen77082ca2017-09-27 21:38:59 -04003137 /* Do not exceed controller limit */
3138 rw_max = min(rw_max, queue_max_hw_sectors(q));
3139
3140 /*
3141 * Only update max_sectors if previously unset or if the current value
3142 * exceeds the capabilities of the hardware.
3143 */
3144 if (sdkp->first_scan ||
3145 q->limits.max_sectors > q->limits.max_dev_sectors ||
3146 q->limits.max_sectors > q->limits.max_hw_sectors)
3147 q->limits.max_sectors = rw_max;
3148
3149 sdkp->first_scan = 0;
Martin K. Petersen4f258a42015-06-23 12:13:59 -04003150
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -04003151 set_capacity(disk, logical_to_sectors(sdp, sdkp->capacity));
Martin K. Petersen5db44862012-09-18 12:19:32 -04003152 sd_config_write_same(sdkp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003153 kfree(buffer);
3154
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155 out:
3156 return 0;
3157}
3158
3159/**
Tejun Heo72ec24b2010-05-15 20:09:32 +02003160 * sd_unlock_native_capacity - unlock native capacity
3161 * @disk: struct gendisk to set capacity for
3162 *
3163 * Block layer calls this function if it detects that partitions
3164 * on @disk reach beyond the end of the device. If the SCSI host
3165 * implements ->unlock_native_capacity() method, it's invoked to
3166 * give it a chance to adjust the device capacity.
3167 *
3168 * CONTEXT:
3169 * Defined by block layer. Might sleep.
3170 */
3171static void sd_unlock_native_capacity(struct gendisk *disk)
3172{
3173 struct scsi_device *sdev = scsi_disk(disk)->device;
3174
3175 if (sdev->host->hostt->unlock_native_capacity)
3176 sdev->host->hostt->unlock_native_capacity(sdev);
3177}
3178
3179/**
Tejun Heo3e1a7ff2008-08-25 19:56:17 +09003180 * sd_format_disk_name - format disk name
3181 * @prefix: name prefix - ie. "sd" for SCSI disks
3182 * @index: index of the disk to format name for
3183 * @buf: output buffer
3184 * @buflen: length of the output buffer
3185 *
3186 * SCSI disk names starts at sda. The 26th device is sdz and the
3187 * 27th is sdaa. The last one for two lettered suffix is sdzz
3188 * which is followed by sdaaa.
3189 *
3190 * This is basically 26 base counting with one extra 'nil' entry
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08003191 * at the beginning from the second digit on and can be
Tejun Heo3e1a7ff2008-08-25 19:56:17 +09003192 * determined using similar method as 26 base conversion with the
3193 * index shifted -1 after each digit is computed.
3194 *
3195 * CONTEXT:
3196 * Don't care.
3197 *
3198 * RETURNS:
3199 * 0 on success, -errno on failure.
3200 */
3201static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
3202{
3203 const int base = 'z' - 'a' + 1;
3204 char *begin = buf + strlen(prefix);
3205 char *end = buf + buflen;
3206 char *p;
3207 int unit;
3208
3209 p = end - 1;
3210 *p = '\0';
3211 unit = base;
3212 do {
3213 if (p == begin)
3214 return -EINVAL;
3215 *--p = 'a' + (index % unit);
3216 index = (index / unit) - 1;
3217 } while (index >= 0);
3218
3219 memmove(begin, p, end - p);
3220 memcpy(buf, prefix, strlen(prefix));
3221
3222 return 0;
3223}
3224
Arjan van de Ven4ace92f2009-01-04 05:32:28 -08003225/*
3226 * The asynchronous part of sd_probe
3227 */
3228static void sd_probe_async(void *data, async_cookie_t cookie)
3229{
3230 struct scsi_disk *sdkp = data;
3231 struct scsi_device *sdp;
3232 struct gendisk *gd;
3233 u32 index;
3234 struct device *dev;
3235
3236 sdp = sdkp->device;
3237 gd = sdkp->disk;
3238 index = sdkp->index;
3239 dev = &sdp->sdev_gendev;
3240
Michael Reed1a03ae02010-09-20 11:20:22 -05003241 gd->major = sd_major((index & 0xf0) >> 4);
3242 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
Michael Reed1a03ae02010-09-20 11:20:22 -05003243
Arjan van de Ven4ace92f2009-01-04 05:32:28 -08003244 gd->fops = &sd_fops;
3245 gd->private_data = &sdkp->driver;
3246 gd->queue = sdkp->device->request_queue;
3247
Martin K. Petersen70a9b872009-03-09 11:33:31 -04003248 /* defaults, until the device tells us otherwise */
3249 sdp->sector_size = 512;
3250 sdkp->capacity = 0;
3251 sdkp->media_present = 1;
3252 sdkp->write_prot = 0;
James Bottomley39c60a02013-04-24 14:02:53 -07003253 sdkp->cache_override = 0;
Martin K. Petersen70a9b872009-03-09 11:33:31 -04003254 sdkp->WCE = 0;
3255 sdkp->RCD = 0;
3256 sdkp->ATO = 0;
3257 sdkp->first_scan = 1;
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05003258 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
Martin K. Petersen70a9b872009-03-09 11:33:31 -04003259
Arjan van de Ven4ace92f2009-01-04 05:32:28 -08003260 sd_revalidate_disk(gd);
3261
NeilBrown97fedbb2010-03-16 08:55:32 +01003262 gd->flags = GENHD_FL_EXT_DEVT;
Tejun Heo2bae0092010-12-18 18:42:23 +01003263 if (sdp->removable) {
Arjan van de Ven4ace92f2009-01-04 05:32:28 -08003264 gd->flags |= GENHD_FL_REMOVABLE;
Tejun Heo2bae0092010-12-18 18:42:23 +01003265 gd->events |= DISK_EVENT_MEDIA_CHANGE;
3266 }
Arjan van de Ven4ace92f2009-01-04 05:32:28 -08003267
Aaron Lu10c580e2013-10-10 13:22:36 +08003268 blk_pm_runtime_init(sdp->request_queue, dev);
Hannes Reineckefef912b2018-09-28 08:17:19 +02003269 device_add_disk(dev, gd, NULL);
Martin K. Petersenfe542392012-09-21 12:44:12 -04003270 if (sdkp->capacity)
3271 sd_dif_config_host(sdkp);
Arjan van de Ven4ace92f2009-01-04 05:32:28 -08003272
Martin K. Petersen3821d762009-05-23 11:43:38 -04003273 sd_revalidate_disk(gd);
3274
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003275 if (sdkp->security) {
3276 sdkp->opal_dev = init_opal_dev(sdp, &sd_sec_submit);
3277 if (sdkp->opal_dev)
3278 sd_printk(KERN_NOTICE, sdkp, "supports TCG Opal\n");
3279 }
3280
Arjan van de Ven4ace92f2009-01-04 05:32:28 -08003281 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
3282 sdp->removable ? "removable " : "");
Alan Stern478a8a02010-06-16 14:52:17 -04003283 scsi_autopm_put_device(sdp);
James Bottomleyea038f62009-08-21 09:47:54 -06003284 put_device(&sdkp->dev);
Arjan van de Ven4ace92f2009-01-04 05:32:28 -08003285}
3286
Tejun Heo3e1a7ff2008-08-25 19:56:17 +09003287/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07003288 * sd_probe - called during driver initialization and whenever a
3289 * new scsi device is attached to the system. It is called once
3290 * for each scsi device (not just disks) present.
3291 * @dev: pointer to device object
3292 *
3293 * Returns 0 if successful (or not interested in this scsi device
3294 * (e.g. scanner)); 1 when there is an error.
3295 *
3296 * Note: this function is invoked from the scsi mid-level.
3297 * This function sets up the mapping between a given
3298 * <host,channel,id,lun> (found in sdp) and new device name
3299 * (e.g. /dev/sda). More precisely it is the block device major
3300 * and minor number that is chosen here.
3301 *
Petr Uzel2db93ce2012-02-24 16:56:54 +01003302 * Assume sd_probe is not re-entrant (for time being)
3303 * Also think about sd_probe() and sd_remove() running coincidentally.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003304 **/
3305static int sd_probe(struct device *dev)
3306{
3307 struct scsi_device *sdp = to_scsi_device(dev);
3308 struct scsi_disk *sdkp;
3309 struct gendisk *gd;
H Hartley Sweeten439d77f2010-08-10 18:01:20 -07003310 int index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003311 int error;
3312
Subhash Jadavani6fe8c1d2014-09-10 14:54:09 +03003313 scsi_autopm_get_device(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314 error = -ENODEV;
Hannes Reinecke89d94752016-10-18 15:40:34 +09003315 if (sdp->type != TYPE_DISK &&
3316 sdp->type != TYPE_ZBC &&
3317 sdp->type != TYPE_MOD &&
3318 sdp->type != TYPE_RBC)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003319 goto out;
3320
Hannes Reinecke89d94752016-10-18 15:40:34 +09003321#ifndef CONFIG_BLK_DEV_ZONED
3322 if (sdp->type == TYPE_ZBC)
3323 goto out;
3324#endif
James Bottomley9ccfc752005-10-02 11:45:08 -05003325 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
Petr Uzel2db93ce2012-02-24 16:56:54 +01003326 "sd_probe\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327
3328 error = -ENOMEM;
Jes Sorensen24669f752006-01-16 10:31:18 -05003329 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003330 if (!sdkp)
3331 goto out;
3332
Tejun Heo689d6fa2008-08-25 19:56:16 +09003333 gd = alloc_disk(SD_MINORS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003334 if (!gd)
Jan Karac01228d2017-03-08 17:48:34 +01003335 goto out_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336
Matthew Wilcox94015082018-06-11 15:26:27 -04003337 index = ida_alloc(&sd_index_ida, GFP_KERNEL);
3338 if (index < 0) {
Dave Kleikamp21208ae2011-10-19 11:49:04 -05003339 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003340 goto out_put;
Michael Reed1a03ae02010-09-20 11:20:22 -05003341 }
3342
Tejun Heo3e1a7ff2008-08-25 19:56:17 +09003343 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
Dave Kleikamp21208ae2011-10-19 11:49:04 -05003344 if (error) {
3345 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
Tejun Heof27bac22008-07-14 14:59:30 +09003346 goto out_free_index;
Dave Kleikamp21208ae2011-10-19 11:49:04 -05003347 }
Tejun Heof27bac22008-07-14 14:59:30 +09003348
Linus Torvalds1da177e2005-04-16 15:20:36 -07003349 sdkp->device = sdp;
3350 sdkp->driver = &sd_template;
3351 sdkp->disk = gd;
3352 sdkp->index = index;
Arnd Bergmann409f3492010-07-07 16:51:29 +02003353 atomic_set(&sdkp->openers, 0);
Josh Hunt9e1a1532012-06-09 07:03:39 -07003354 atomic_set(&sdkp->device->ioerr_cnt, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003355
James Bottomley601e7632009-05-26 20:35:48 +00003356 if (!sdp->request_queue->rq_timeout) {
3357 if (sdp->type != TYPE_MOD)
3358 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
3359 else
3360 blk_queue_rq_timeout(sdp->request_queue,
3361 SD_MOD_TIMEOUT);
3362 }
3363
3364 device_initialize(&sdkp->dev);
Alan Stern478a8a02010-06-16 14:52:17 -04003365 sdkp->dev.parent = dev;
James Bottomley601e7632009-05-26 20:35:48 +00003366 sdkp->dev.class = &sd_disk_class;
Kees Cook02aa2a32013-07-03 15:04:56 -07003367 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
James Bottomley601e7632009-05-26 20:35:48 +00003368
Dan Carpenterdee05862015-01-19 17:41:12 +03003369 error = device_add(&sdkp->dev);
3370 if (error)
James Bottomley601e7632009-05-26 20:35:48 +00003371 goto out_free_index;
3372
Alan Stern478a8a02010-06-16 14:52:17 -04003373 get_device(dev);
3374 dev_set_drvdata(dev, sdkp);
James Bottomley601e7632009-05-26 20:35:48 +00003375
James Bottomleyea038f62009-08-21 09:47:54 -06003376 get_device(&sdkp->dev); /* prevent release before async_schedule */
Dan Williamsa7a20d12012-03-22 17:05:11 -07003377 async_schedule_domain(sd_probe_async, sdkp, &scsi_sd_probe_domain);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003378
3379 return 0;
3380
Tejun Heof27bac22008-07-14 14:59:30 +09003381 out_free_index:
Matthew Wilcox94015082018-06-11 15:26:27 -04003382 ida_free(&sd_index_ida, index);
James Bottomley6bdaa1f2006-03-18 14:14:21 -06003383 out_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003384 put_disk(gd);
Colin Ian Kingf1703962017-02-03 19:38:54 +00003385 out_free:
3386 kfree(sdkp);
James Bottomley6bdaa1f2006-03-18 14:14:21 -06003387 out:
Subhash Jadavani6fe8c1d2014-09-10 14:54:09 +03003388 scsi_autopm_put_device(sdp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003389 return error;
3390}
3391
3392/**
3393 * sd_remove - called whenever a scsi disk (previously recognized by
3394 * sd_probe) is detached from the system. It is called (potentially
3395 * multiple times) during sd module unload.
John Pittmanf2a33132017-01-12 16:17:20 -05003396 * @dev: pointer to device object
Linus Torvalds1da177e2005-04-16 15:20:36 -07003397 *
3398 * Note: this function is invoked from the scsi mid-level.
3399 * This function potentially frees up a device name (e.g. /dev/sdc)
3400 * that could be re-used by a subsequent sd_probe().
3401 * This function is not called when the built-in sd driver is "exit-ed".
3402 **/
3403static int sd_remove(struct device *dev)
3404{
James Bottomley601e7632009-05-26 20:35:48 +00003405 struct scsi_disk *sdkp;
Hannes Reinecke0761df92013-05-10 11:06:16 +02003406 dev_t devt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003407
James Bottomley601e7632009-05-26 20:35:48 +00003408 sdkp = dev_get_drvdata(dev);
Hannes Reinecke0761df92013-05-10 11:06:16 +02003409 devt = disk_devt(sdkp->disk);
Alan Stern478a8a02010-06-16 14:52:17 -04003410 scsi_autopm_get_device(sdkp->device);
3411
Dan Williams3c31b522014-04-10 15:30:35 -07003412 async_synchronize_full_domain(&scsi_sd_pm_domain);
Dan Williamsa7a20d12012-03-22 17:05:11 -07003413 async_synchronize_full_domain(&scsi_sd_probe_domain);
Tony Jonesee959b02008-02-22 00:13:36 +01003414 device_del(&sdkp->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003415 del_gendisk(sdkp->disk);
3416 sd_shutdown(dev);
Alan Stern39b7f1e2005-11-04 14:44:41 -05003417
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003418 free_opal_dev(sdkp->opal_dev);
3419
Hannes Reinecke0761df92013-05-10 11:06:16 +02003420 blk_register_region(devt, SD_MINORS, NULL,
3421 sd_default_probe, NULL, NULL);
3422
Arjan van de Ven0b950672006-01-11 13:16:10 +01003423 mutex_lock(&sd_ref_mutex);
Alan Stern39b7f1e2005-11-04 14:44:41 -05003424 dev_set_drvdata(dev, NULL);
Tony Jonesee959b02008-02-22 00:13:36 +01003425 put_device(&sdkp->dev);
Arjan van de Ven0b950672006-01-11 13:16:10 +01003426 mutex_unlock(&sd_ref_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003427
3428 return 0;
3429}
3430
3431/**
3432 * scsi_disk_release - Called to free the scsi_disk structure
Tony Jonesee959b02008-02-22 00:13:36 +01003433 * @dev: pointer to embedded class device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003434 *
Arjan van de Ven0b950672006-01-11 13:16:10 +01003435 * sd_ref_mutex must be held entering this routine. Because it is
Linus Torvalds1da177e2005-04-16 15:20:36 -07003436 * called on last put, you should always use the scsi_disk_get()
3437 * scsi_disk_put() helpers which manipulate the semaphore directly
Tony Jonesee959b02008-02-22 00:13:36 +01003438 * and never do a direct put_device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003439 **/
Tony Jonesee959b02008-02-22 00:13:36 +01003440static void scsi_disk_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003441{
Tony Jonesee959b02008-02-22 00:13:36 +01003442 struct scsi_disk *sdkp = to_scsi_disk(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003443 struct gendisk *disk = sdkp->disk;
3444
Matthew Wilcox94015082018-06-11 15:26:27 -04003445 ida_free(&sd_index_ida, sdkp->index);
Jan Karac01228d2017-03-08 17:48:34 +01003446
Linus Torvalds1da177e2005-04-16 15:20:36 -07003447 disk->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003448 put_disk(disk);
Alan Stern39b7f1e2005-11-04 14:44:41 -05003449 put_device(&sdkp->device->sdev_gendev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003450
3451 kfree(sdkp);
3452}
3453
James Bottomleycc5d2c82007-03-20 12:26:03 -05003454static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003455{
3456 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3457 struct scsi_sense_hdr sshdr;
James Bottomleycc5d2c82007-03-20 12:26:03 -05003458 struct scsi_device *sdp = sdkp->device;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003459 int res;
3460
3461 if (start)
3462 cmd[4] |= 1; /* START */
3463
Stefan Richterd2886ea2008-05-11 00:34:07 +02003464 if (sdp->start_stop_pwr_cond)
3465 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3466
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003467 if (!scsi_device_online(sdp))
3468 return -ENODEV;
3469
Christoph Hellwigfcbfffe2017-02-23 16:02:37 +01003470 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, &sshdr,
3471 SD_TIMEOUT, SD_MAX_RETRIES, 0, RQF_PM, NULL);
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003472 if (res) {
Hannes Reineckeef613292014-10-24 14:27:00 +02003473 sd_print_result(sdkp, "Start/Stop Unit failed", res);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +02003474 if (driver_byte(res) == DRIVER_SENSE)
James Bottomleycc5d2c82007-03-20 12:26:03 -05003475 sd_print_sense_hdr(sdkp, &sshdr);
Oliver Neukum95897912013-09-16 13:28:15 +02003476 if (scsi_sense_valid(&sshdr) &&
3477 /* 0x3a is medium not present */
3478 sshdr.asc == 0x3a)
3479 res = 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003480 }
3481
Oliver Neukum95897912013-09-16 13:28:15 +02003482 /* SCSI error codes must not go to the generic layer */
3483 if (res)
3484 return -EIO;
3485
3486 return 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003487}
3488
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489/*
3490 * Send a SYNCHRONIZE CACHE instruction down to the device through
3491 * the normal SCSI command structure. Wait for the command to
3492 * complete.
3493 */
3494static void sd_shutdown(struct device *dev)
3495{
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003496 struct scsi_disk *sdkp = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497
3498 if (!sdkp)
3499 return; /* this can happen */
3500
Lin Ming54f575882011-12-05 09:20:26 +08003501 if (pm_runtime_suspended(dev))
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003502 return;
Lin Ming54f575882011-12-05 09:20:26 +08003503
Oliver Neukum95897912013-09-16 13:28:15 +02003504 if (sdkp->WCE && sdkp->media_present) {
Martin K. Petersene73aec82007-02-27 22:40:55 -05003505 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
Derek Basehore4fa83242017-05-11 14:34:24 +02003506 sd_sync_cache(sdkp, NULL);
Alan Stern39b7f1e2005-11-04 14:44:41 -05003507 }
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003508
James Bottomleycc5d2c82007-03-20 12:26:03 -05003509 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3510 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3511 sd_start_stop_device(sdkp, 0);
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003512 }
Alan Stern39b7f1e2005-11-04 14:44:41 -05003513}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514
Oliver Neukum95897912013-09-16 13:28:15 +02003515static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003516{
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003517 struct scsi_disk *sdkp = dev_get_drvdata(dev);
Derek Basehore4fa83242017-05-11 14:34:24 +02003518 struct scsi_sense_hdr sshdr;
Alan Stern09ff92f2007-05-21 09:55:04 -04003519 int ret = 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003520
Alan Stern13b43892016-01-20 11:26:01 -05003521 if (!sdkp) /* E.g.: runtime suspend following sd_remove() */
3522 return 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003523
Oliver Neukum95897912013-09-16 13:28:15 +02003524 if (sdkp->WCE && sdkp->media_present) {
James Bottomleycc5d2c82007-03-20 12:26:03 -05003525 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
Derek Basehore4fa83242017-05-11 14:34:24 +02003526 ret = sd_sync_cache(sdkp, &sshdr);
3527
Oliver Neukum95897912013-09-16 13:28:15 +02003528 if (ret) {
3529 /* ignore OFFLINE device */
3530 if (ret == -ENODEV)
Derek Basehore4fa83242017-05-11 14:34:24 +02003531 return 0;
3532
3533 if (!scsi_sense_valid(&sshdr) ||
3534 sshdr.sense_key != ILLEGAL_REQUEST)
3535 return ret;
3536
3537 /*
3538 * sshdr.sense_key == ILLEGAL_REQUEST means this drive
3539 * doesn't support sync. There's not much to do and
3540 * suspend shouldn't fail.
3541 */
Bart Van Asscheed91f7e2017-08-25 13:46:34 -07003542 ret = 0;
Oliver Neukum95897912013-09-16 13:28:15 +02003543 }
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003544 }
3545
Aaron Lu691e3d32012-11-09 15:27:55 +08003546 if (sdkp->device->manage_start_stop) {
James Bottomleycc5d2c82007-03-20 12:26:03 -05003547 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
Oliver Neukum95897912013-09-16 13:28:15 +02003548 /* an error is not worth aborting a system sleep */
James Bottomleycc5d2c82007-03-20 12:26:03 -05003549 ret = sd_start_stop_device(sdkp, 0);
Oliver Neukum95897912013-09-16 13:28:15 +02003550 if (ignore_stop_errors)
3551 ret = 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003552 }
3553
Alan Stern09ff92f2007-05-21 09:55:04 -04003554 return ret;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003555}
3556
Oliver Neukum95897912013-09-16 13:28:15 +02003557static int sd_suspend_system(struct device *dev)
3558{
3559 return sd_suspend_common(dev, true);
3560}
3561
3562static int sd_suspend_runtime(struct device *dev)
3563{
3564 return sd_suspend_common(dev, false);
3565}
3566
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003567static int sd_resume(struct device *dev)
3568{
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003569 struct scsi_disk *sdkp = dev_get_drvdata(dev);
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003570 int ret;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003571
Alan Stern13b43892016-01-20 11:26:01 -05003572 if (!sdkp) /* E.g.: runtime resume at the start of sd_probe() */
3573 return 0;
3574
James Bottomleycc5d2c82007-03-20 12:26:03 -05003575 if (!sdkp->device->manage_start_stop)
Christoph Hellwig3d9a1f52015-02-02 14:01:25 +01003576 return 0;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003577
James Bottomleycc5d2c82007-03-20 12:26:03 -05003578 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
Christoph Hellwigd80210f2017-06-19 14:26:46 +02003579 ret = sd_start_stop_device(sdkp, 1);
3580 if (!ret)
3581 opal_unlock_from_suspend(sdkp->opal_dev);
3582 return ret;
Tejun Heoc3c94c5a2007-03-21 00:13:59 +09003583}
3584
Linus Torvalds1da177e2005-04-16 15:20:36 -07003585/**
3586 * init_sd - entry point for this driver (both when built in or when
3587 * a module).
3588 *
3589 * Note: this function registers this driver with the scsi mid-level.
3590 **/
3591static int __init init_sd(void)
3592{
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003593 int majors = 0, i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003594
3595 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3596
Hannes Reinecke0761df92013-05-10 11:06:16 +02003597 for (i = 0; i < SD_MAJORS; i++) {
3598 if (register_blkdev(sd_major(i), "sd") != 0)
3599 continue;
3600 majors++;
3601 blk_register_region(sd_major(i), SD_MINORS, NULL,
3602 sd_default_probe, NULL, NULL);
3603 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604
3605 if (!majors)
3606 return -ENODEV;
3607
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003608 err = class_register(&sd_disk_class);
3609 if (err)
3610 goto err_out;
James Bottomley6bdaa1f2006-03-18 14:14:21 -06003611
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003612 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3613 0, 0, NULL);
3614 if (!sd_cdb_cache) {
3615 printk(KERN_ERR "sd: can't init extended cdb cache\n");
Clément Calmels8d964472014-06-03 23:34:25 +02003616 err = -ENOMEM;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003617 goto err_out_class;
3618 }
3619
3620 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3621 if (!sd_cdb_pool) {
3622 printk(KERN_ERR "sd: can't init extended cdb pool\n");
Clément Calmels8d964472014-06-03 23:34:25 +02003623 err = -ENOMEM;
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003624 goto err_out_cache;
3625 }
3626
Jens Axboe61cce6f2018-12-12 06:46:55 -07003627 sd_page_pool = mempool_create_page_pool(SD_MEMPOOL_SIZE, 0);
3628 if (!sd_page_pool) {
3629 printk(KERN_ERR "sd: can't init discard page pool\n");
3630 err = -ENOMEM;
3631 goto err_out_ppool;
3632 }
3633
Joel D. Diazafd5e342012-10-10 10:36:11 +02003634 err = scsi_register_driver(&sd_template.gendrv);
3635 if (err)
3636 goto err_out_driver;
3637
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003638 return 0;
3639
Joel D. Diazafd5e342012-10-10 10:36:11 +02003640err_out_driver:
Jens Axboe61cce6f2018-12-12 06:46:55 -07003641 mempool_destroy(sd_page_pool);
3642
3643err_out_ppool:
Joel D. Diazafd5e342012-10-10 10:36:11 +02003644 mempool_destroy(sd_cdb_pool);
3645
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003646err_out_cache:
3647 kmem_cache_destroy(sd_cdb_cache);
3648
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003649err_out_class:
3650 class_unregister(&sd_disk_class);
3651err_out:
3652 for (i = 0; i < SD_MAJORS; i++)
3653 unregister_blkdev(sd_major(i), "sd");
3654 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003655}
3656
3657/**
3658 * exit_sd - exit point for this driver (when it is a module).
3659 *
3660 * Note: this function unregisters this driver from the scsi mid-level.
3661 **/
3662static void __exit exit_sd(void)
3663{
3664 int i;
3665
3666 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3667
Joel D. Diazafd5e342012-10-10 10:36:11 +02003668 scsi_unregister_driver(&sd_template.gendrv);
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003669 mempool_destroy(sd_cdb_pool);
Jens Axboe61cce6f2018-12-12 06:46:55 -07003670 mempool_destroy(sd_page_pool);
Martin K. Petersen4e7392e2009-09-20 16:49:38 -04003671 kmem_cache_destroy(sd_cdb_cache);
3672
Jeff Garzik5e4009b2006-10-04 05:32:54 -04003673 class_unregister(&sd_disk_class);
3674
Hannes Reinecke0761df92013-05-10 11:06:16 +02003675 for (i = 0; i < SD_MAJORS; i++) {
3676 blk_unregister_region(sd_major(i), SD_MINORS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003677 unregister_blkdev(sd_major(i), "sd");
Hannes Reinecke0761df92013-05-10 11:06:16 +02003678 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003679}
3680
Linus Torvalds1da177e2005-04-16 15:20:36 -07003681module_init(init_sd);
3682module_exit(exit_sd);
Martin K. Petersene73aec82007-02-27 22:40:55 -05003683
3684static void sd_print_sense_hdr(struct scsi_disk *sdkp,
3685 struct scsi_sense_hdr *sshdr)
3686{
Hannes Reinecke21045512015-01-08 07:43:46 +01003687 scsi_print_sense_hdr(sdkp->device,
3688 sdkp->disk ? sdkp->disk->disk_name : NULL, sshdr);
Martin K. Petersene73aec82007-02-27 22:40:55 -05003689}
3690
Hannes Reineckeef613292014-10-24 14:27:00 +02003691static void sd_print_result(const struct scsi_disk *sdkp, const char *msg,
3692 int result)
Martin K. Petersene73aec82007-02-27 22:40:55 -05003693{
Hannes Reineckeef613292014-10-24 14:27:00 +02003694 const char *hb_string = scsi_hostbyte_string(result);
3695 const char *db_string = scsi_driverbyte_string(result);
3696
3697 if (hb_string || db_string)
3698 sd_printk(KERN_INFO, sdkp,
3699 "%s: Result: hostbyte=%s driverbyte=%s\n", msg,
3700 hb_string ? hb_string : "invalid",
3701 db_string ? db_string : "invalid");
3702 else
3703 sd_printk(KERN_INFO, sdkp,
3704 "%s: Result: hostbyte=0x%02x driverbyte=0x%02x\n",
3705 msg, host_byte(result), driver_byte(result));
Martin K. Petersene73aec82007-02-27 22:40:55 -05003706}
3707