scsi: sd: Create helper functions for read/write commands
[linux-2.6-block.git] / drivers / scsi / sd.c
CommitLineData
1da177e4
LT
1/*
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
1da177e4
LT
35#include <linux/module.h>
36#include <linux/fs.h>
37#include <linux/kernel.h>
1da177e4
LT
38#include <linux/mm.h>
39#include <linux/bio.h>
40#include <linux/genhd.h>
41#include <linux/hdreg.h>
42#include <linux/errno.h>
43#include <linux/idr.h>
44#include <linux/interrupt.h>
45#include <linux/init.h>
46#include <linux/blkdev.h>
47#include <linux/blkpg.h>
bca6b067 48#include <linux/blk-pm.h>
1da177e4 49#include <linux/delay.h>
0b950672 50#include <linux/mutex.h>
7404ad3b 51#include <linux/string_helpers.h>
4ace92fc 52#include <linux/async.h>
5a0e3ad6 53#include <linux/slab.h>
d80210f2 54#include <linux/sed-opal.h>
54f57588 55#include <linux/pm_runtime.h>
924d55b0 56#include <linux/pr.h>
8475c811 57#include <linux/t10-pi.h>
7c0f6ba6 58#include <linux/uaccess.h>
8f76d151 59#include <asm/unaligned.h>
1da177e4
LT
60
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>
1da177e4
LT
69#include <scsi/scsicam.h>
70
aa91696e 71#include "sd.h"
a7a20d10 72#include "scsi_priv.h"
1da177e4
LT
73#include "scsi_logging.h"
74
f018fa55
RH
75MODULE_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);
d7b8bcb0
MT
95MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
96MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
97MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
89d94756 98MODULE_ALIAS_SCSI_DEVICE(TYPE_ZBC);
f018fa55 99
870d6656 100#if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
f615b48c 101#define SD_MINORS 16
870d6656 102#else
3e1a7ff8 103#define SD_MINORS 0
870d6656
TH
104#endif
105
c98a0eb0 106static void sd_config_discard(struct scsi_disk *, unsigned int);
5db44863 107static void sd_config_write_same(struct scsi_disk *);
7b3d9545 108static int sd_revalidate_disk(struct gendisk *);
72ec24bd 109static void sd_unlock_native_capacity(struct gendisk *disk);
7b3d9545
LT
110static int sd_probe(struct device *);
111static int sd_remove(struct device *);
112static void sd_shutdown(struct device *);
95897910
ON
113static int sd_suspend_system(struct device *);
114static int sd_suspend_runtime(struct device *);
7b3d9545
LT
115static int sd_resume(struct device *);
116static void sd_rescan(struct device *);
159b2cbf 117static blk_status_t sd_init_command(struct scsi_cmnd *SCpnt);
a1b73fc1 118static void sd_uninit_command(struct scsi_cmnd *SCpnt);
7b3d9545 119static int sd_done(struct scsi_cmnd *);
7a38dc0b 120static void sd_eh_reset(struct scsi_cmnd *);
2451079b 121static int sd_eh_action(struct scsi_cmnd *, int);
7b3d9545 122static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
ee959b00 123static void scsi_disk_release(struct device *cdev);
7b3d9545 124static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
ef61329d 125static void sd_print_result(const struct scsi_disk *, const char *, int);
7b3d9545 126
f27bac27 127static DEFINE_IDA(sd_index_ida);
1da177e4
LT
128
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) */
0b950672 132static DEFINE_MUTEX(sd_ref_mutex);
1da177e4 133
439d77f7
HS
134static struct kmem_cache *sd_cdb_cache;
135static mempool_t *sd_cdb_pool;
61cce6f6 136static mempool_t *sd_page_pool;
4e7392ec 137
6bdaa1f1
JB
138static const char *sd_cache_types[] = {
139 "write through", "none", "write back",
140 "write back, no read (daft)"
141};
142
cb2fb68d
VC
143static void sd_set_flush_flag(struct scsi_disk *sdkp)
144{
eb310e23 145 bool wc = false, fua = false;
cb2fb68d
VC
146
147 if (sdkp->WCE) {
eb310e23 148 wc = true;
cb2fb68d 149 if (sdkp->DPOFUA)
eb310e23 150 fua = true;
cb2fb68d
VC
151 }
152
eb310e23 153 blk_queue_write_cache(sdkp->disk->queue, wc, fua);
cb2fb68d
VC
154}
155
ee959b00 156static ssize_t
e1ea2351
GKH
157cache_type_store(struct device *dev, struct device_attribute *attr,
158 const char *buf, size_t count)
6bdaa1f1 159{
4c11712a 160 int ct, rcd, wce, sp;
ee959b00 161 struct scsi_disk *sdkp = to_scsi_disk(dev);
6bdaa1f1
JB
162 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;
2ee3e26c 167 static const char temp[] = "temporary ";
6bdaa1f1
JB
168 int len;
169
89d94756 170 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
6bdaa1f1
JB
171 /* 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
39c60a09
JB
176 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
4c11712a 183 ct = sysfs_match_string(sd_cache_types, buf);
6bdaa1f1
JB
184 if (ct < 0)
185 return -EINVAL;
4c11712a 186
6bdaa1f1 187 rcd = ct & 0x01 ? 1 : 0;
2eefd57b 188 wce = (ct & 0x02) && !sdkp->write_prot ? 1 : 0;
39c60a09
JB
189
190 if (sdkp->cache_override) {
191 sdkp->WCE = wce;
192 sdkp->RCD = rcd;
cb2fb68d 193 sd_set_flush_flag(sdkp);
39c60a09
JB
194 return count;
195 }
196
6bdaa1f1
JB
197 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
198 SD_MAX_RETRIES, &data, NULL))
199 return -EINVAL;
a9312fb8 200 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
6bdaa1f1
JB
201 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;
2c5d16d6 207 buffer_data[0] &= ~0x80;
6bdaa1f1
JB
208
209 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
210 SD_MAX_RETRIES, &data, &sshdr)) {
211 if (scsi_sense_valid(&sshdr))
e73aec82 212 sd_print_sense_hdr(sdkp, &sshdr);
6bdaa1f1
JB
213 return -EINVAL;
214 }
f98a8cae 215 revalidate_disk(sdkp->disk);
6bdaa1f1
JB
216 return count;
217}
218
ee959b00 219static ssize_t
e1ea2351
GKH
220manage_start_stop_show(struct device *dev, struct device_attribute *attr,
221 char *buf)
222{
223 struct scsi_disk *sdkp = to_scsi_disk(dev);
224 struct scsi_device *sdp = sdkp->device;
225
4c11712a 226 return sprintf(buf, "%u\n", sdp->manage_start_stop);
e1ea2351
GKH
227}
228
229static ssize_t
230manage_start_stop_store(struct device *dev, struct device_attribute *attr,
231 const char *buf, size_t count)
c3c94c5a 232{
ee959b00 233 struct scsi_disk *sdkp = to_scsi_disk(dev);
c3c94c5a 234 struct scsi_device *sdp = sdkp->device;
623401ee 235 bool v;
c3c94c5a
TH
236
237 if (!capable(CAP_SYS_ADMIN))
238 return -EACCES;
239
623401ee 240 if (kstrtobool(buf, &v))
241 return -EINVAL;
242
243 sdp->manage_start_stop = v;
c3c94c5a
TH
244
245 return count;
246}
e1ea2351 247static DEVICE_ATTR_RW(manage_start_stop);
c3c94c5a 248
ee959b00 249static ssize_t
e1ea2351
GKH
250allow_restart_show(struct device *dev, struct device_attribute *attr, char *buf)
251{
252 struct scsi_disk *sdkp = to_scsi_disk(dev);
253
4c11712a 254 return sprintf(buf, "%u\n", sdkp->device->allow_restart);
e1ea2351
GKH
255}
256
257static ssize_t
258allow_restart_store(struct device *dev, struct device_attribute *attr,
259 const char *buf, size_t count)
a144c5ae 260{
658e9a6d 261 bool v;
ee959b00 262 struct scsi_disk *sdkp = to_scsi_disk(dev);
a144c5ae
BK
263 struct scsi_device *sdp = sdkp->device;
264
265 if (!capable(CAP_SYS_ADMIN))
266 return -EACCES;
267
89d94756 268 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
a144c5ae
BK
269 return -EINVAL;
270
658e9a6d 271 if (kstrtobool(buf, &v))
272 return -EINVAL;
273
274 sdp->allow_restart = v;
a144c5ae
BK
275
276 return count;
277}
e1ea2351 278static DEVICE_ATTR_RW(allow_restart);
a144c5ae 279
ee959b00 280static ssize_t
e1ea2351 281cache_type_show(struct device *dev, struct device_attribute *attr, char *buf)
6bdaa1f1 282{
ee959b00 283 struct scsi_disk *sdkp = to_scsi_disk(dev);
6bdaa1f1
JB
284 int ct = sdkp->RCD + 2*sdkp->WCE;
285
4c11712a 286 return sprintf(buf, "%s\n", sd_cache_types[ct]);
6bdaa1f1 287}
e1ea2351 288static DEVICE_ATTR_RW(cache_type);
6bdaa1f1 289
ee959b00 290static ssize_t
e1ea2351 291FUA_show(struct device *dev, struct device_attribute *attr, char *buf)
6bdaa1f1 292{
ee959b00 293 struct scsi_disk *sdkp = to_scsi_disk(dev);
6bdaa1f1 294
4c11712a 295 return sprintf(buf, "%u\n", sdkp->DPOFUA);
6bdaa1f1 296}
e1ea2351 297static DEVICE_ATTR_RO(FUA);
6bdaa1f1 298
ee959b00 299static ssize_t
e1ea2351
GKH
300protection_type_show(struct device *dev, struct device_attribute *attr,
301 char *buf)
e0597d70
MP
302{
303 struct scsi_disk *sdkp = to_scsi_disk(dev);
304
4c11712a 305 return sprintf(buf, "%u\n", sdkp->protection_type);
e0597d70
MP
306}
307
8172499a 308static ssize_t
e1ea2351
GKH
309protection_type_store(struct device *dev, struct device_attribute *attr,
310 const char *buf, size_t count)
8172499a
MP
311{
312 struct scsi_disk *sdkp = to_scsi_disk(dev);
313 unsigned int val;
314 int err;
315
316 if (!capable(CAP_SYS_ADMIN))
317 return -EACCES;
318
319 err = kstrtouint(buf, 10, &val);
320
321 if (err)
322 return err;
323
830cc351 324 if (val <= T10_PI_TYPE3_PROTECTION)
8172499a
MP
325 sdkp->protection_type = val;
326
327 return count;
328}
e1ea2351 329static DEVICE_ATTR_RW(protection_type);
8172499a 330
518fa8e3 331static ssize_t
e1ea2351
GKH
332protection_mode_show(struct device *dev, struct device_attribute *attr,
333 char *buf)
518fa8e3
MP
334{
335 struct scsi_disk *sdkp = to_scsi_disk(dev);
336 struct scsi_device *sdp = sdkp->device;
337 unsigned int dif, dix;
338
339 dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
340 dix = scsi_host_dix_capable(sdp->host, sdkp->protection_type);
341
8475c811 342 if (!dix && scsi_host_dix_capable(sdp->host, T10_PI_TYPE0_PROTECTION)) {
518fa8e3
MP
343 dif = 0;
344 dix = 1;
345 }
346
347 if (!dif && !dix)
4c11712a 348 return sprintf(buf, "none\n");
518fa8e3 349
4c11712a 350 return sprintf(buf, "%s%u\n", dix ? "dix" : "dif", dif);
518fa8e3 351}
e1ea2351 352static DEVICE_ATTR_RO(protection_mode);
518fa8e3 353
e0597d70 354static ssize_t
e1ea2351 355app_tag_own_show(struct device *dev, struct device_attribute *attr, char *buf)
e0597d70
MP
356{
357 struct scsi_disk *sdkp = to_scsi_disk(dev);
358
4c11712a 359 return sprintf(buf, "%u\n", sdkp->ATO);
e0597d70 360}
e1ea2351 361static DEVICE_ATTR_RO(app_tag_own);
e0597d70 362
e339c1a7 363static ssize_t
e1ea2351
GKH
364thin_provisioning_show(struct device *dev, struct device_attribute *attr,
365 char *buf)
e339c1a7
MP
366{
367 struct scsi_disk *sdkp = to_scsi_disk(dev);
368
4c11712a 369 return sprintf(buf, "%u\n", sdkp->lbpme);
c98a0eb0 370}
e1ea2351 371static DEVICE_ATTR_RO(thin_provisioning);
c98a0eb0 372
4c11712a 373/* sysfs_match_string() requires dense arrays */
c98a0eb0
MP
374static const char *lbp_mode[] = {
375 [SD_LBP_FULL] = "full",
376 [SD_LBP_UNMAP] = "unmap",
377 [SD_LBP_WS16] = "writesame_16",
378 [SD_LBP_WS10] = "writesame_10",
379 [SD_LBP_ZERO] = "writesame_zero",
380 [SD_LBP_DISABLE] = "disabled",
381};
382
383static ssize_t
e1ea2351
GKH
384provisioning_mode_show(struct device *dev, struct device_attribute *attr,
385 char *buf)
c98a0eb0
MP
386{
387 struct scsi_disk *sdkp = to_scsi_disk(dev);
388
4c11712a 389 return sprintf(buf, "%s\n", lbp_mode[sdkp->provisioning_mode]);
c98a0eb0
MP
390}
391
392static ssize_t
e1ea2351
GKH
393provisioning_mode_store(struct device *dev, struct device_attribute *attr,
394 const char *buf, size_t count)
c98a0eb0
MP
395{
396 struct scsi_disk *sdkp = to_scsi_disk(dev);
397 struct scsi_device *sdp = sdkp->device;
4c11712a 398 int mode;
c98a0eb0
MP
399
400 if (!capable(CAP_SYS_ADMIN))
401 return -EACCES;
402
89d94756
HR
403 if (sd_is_zoned(sdkp)) {
404 sd_config_discard(sdkp, SD_LBP_DISABLE);
405 return count;
406 }
407
c98a0eb0
MP
408 if (sdp->type != TYPE_DISK)
409 return -EINVAL;
410
4c11712a
MP
411 mode = sysfs_match_string(lbp_mode, buf);
412 if (mode < 0)
c98a0eb0
MP
413 return -EINVAL;
414
4c11712a
MP
415 sd_config_discard(sdkp, mode);
416
c98a0eb0 417 return count;
e339c1a7 418}
e1ea2351 419static DEVICE_ATTR_RW(provisioning_mode);
e339c1a7 420
4c11712a 421/* sysfs_match_string() requires dense arrays */
e6bd9312
MP
422static const char *zeroing_mode[] = {
423 [SD_ZERO_WRITE] = "write",
424 [SD_ZERO_WS] = "writesame",
425 [SD_ZERO_WS16_UNMAP] = "writesame_16_unmap",
426 [SD_ZERO_WS10_UNMAP] = "writesame_10_unmap",
427};
428
429static ssize_t
430zeroing_mode_show(struct device *dev, struct device_attribute *attr,
431 char *buf)
432{
433 struct scsi_disk *sdkp = to_scsi_disk(dev);
434
4c11712a 435 return sprintf(buf, "%s\n", zeroing_mode[sdkp->zeroing_mode]);
e6bd9312
MP
436}
437
438static ssize_t
439zeroing_mode_store(struct device *dev, struct device_attribute *attr,
440 const char *buf, size_t count)
441{
442 struct scsi_disk *sdkp = to_scsi_disk(dev);
4c11712a 443 int mode;
e6bd9312
MP
444
445 if (!capable(CAP_SYS_ADMIN))
446 return -EACCES;
447
4c11712a
MP
448 mode = sysfs_match_string(zeroing_mode, buf);
449 if (mode < 0)
e6bd9312
MP
450 return -EINVAL;
451
4c11712a
MP
452 sdkp->zeroing_mode = mode;
453
e6bd9312
MP
454 return count;
455}
456static DEVICE_ATTR_RW(zeroing_mode);
457
18a4d0a2 458static ssize_t
e1ea2351
GKH
459max_medium_access_timeouts_show(struct device *dev,
460 struct device_attribute *attr, char *buf)
18a4d0a2
MP
461{
462 struct scsi_disk *sdkp = to_scsi_disk(dev);
463
4c11712a 464 return sprintf(buf, "%u\n", sdkp->max_medium_access_timeouts);
18a4d0a2
MP
465}
466
467static ssize_t
e1ea2351
GKH
468max_medium_access_timeouts_store(struct device *dev,
469 struct device_attribute *attr, const char *buf,
470 size_t count)
18a4d0a2
MP
471{
472 struct scsi_disk *sdkp = to_scsi_disk(dev);
473 int err;
474
475 if (!capable(CAP_SYS_ADMIN))
476 return -EACCES;
477
478 err = kstrtouint(buf, 10, &sdkp->max_medium_access_timeouts);
479
480 return err ? err : count;
481}
e1ea2351 482static DEVICE_ATTR_RW(max_medium_access_timeouts);
18a4d0a2 483
5db44863 484static ssize_t
e1ea2351
GKH
485max_write_same_blocks_show(struct device *dev, struct device_attribute *attr,
486 char *buf)
5db44863
MP
487{
488 struct scsi_disk *sdkp = to_scsi_disk(dev);
489
4c11712a 490 return sprintf(buf, "%u\n", sdkp->max_ws_blocks);
5db44863
MP
491}
492
493static ssize_t
e1ea2351
GKH
494max_write_same_blocks_store(struct device *dev, struct device_attribute *attr,
495 const char *buf, size_t count)
5db44863
MP
496{
497 struct scsi_disk *sdkp = to_scsi_disk(dev);
498 struct scsi_device *sdp = sdkp->device;
499 unsigned long max;
500 int err;
501
502 if (!capable(CAP_SYS_ADMIN))
503 return -EACCES;
504
89d94756 505 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
5db44863
MP
506 return -EINVAL;
507
508 err = kstrtoul(buf, 10, &max);
509
510 if (err)
511 return err;
512
513 if (max == 0)
514 sdp->no_write_same = 1;
66c28f97
MP
515 else if (max <= SD_MAX_WS16_BLOCKS) {
516 sdp->no_write_same = 0;
5db44863 517 sdkp->max_ws_blocks = max;
66c28f97 518 }
5db44863
MP
519
520 sd_config_write_same(sdkp);
521
522 return count;
523}
e1ea2351
GKH
524static DEVICE_ATTR_RW(max_write_same_blocks);
525
526static struct attribute *sd_disk_attrs[] = {
527 &dev_attr_cache_type.attr,
528 &dev_attr_FUA.attr,
529 &dev_attr_allow_restart.attr,
530 &dev_attr_manage_start_stop.attr,
531 &dev_attr_protection_type.attr,
532 &dev_attr_protection_mode.attr,
533 &dev_attr_app_tag_own.attr,
534 &dev_attr_thin_provisioning.attr,
535 &dev_attr_provisioning_mode.attr,
e6bd9312 536 &dev_attr_zeroing_mode.attr,
e1ea2351
GKH
537 &dev_attr_max_write_same_blocks.attr,
538 &dev_attr_max_medium_access_timeouts.attr,
539 NULL,
6bdaa1f1 540};
e1ea2351 541ATTRIBUTE_GROUPS(sd_disk);
6bdaa1f1
JB
542
543static struct class sd_disk_class = {
544 .name = "scsi_disk",
545 .owner = THIS_MODULE,
ee959b00 546 .dev_release = scsi_disk_release,
e1ea2351 547 .dev_groups = sd_disk_groups,
6bdaa1f1 548};
1da177e4 549
691e3d31 550static const struct dev_pm_ops sd_pm_ops = {
95897910 551 .suspend = sd_suspend_system,
691e3d31 552 .resume = sd_resume,
95897910 553 .poweroff = sd_suspend_system,
691e3d31 554 .restore = sd_resume,
95897910 555 .runtime_suspend = sd_suspend_runtime,
691e3d31
AL
556 .runtime_resume = sd_resume,
557};
558
1da177e4 559static struct scsi_driver sd_template = {
1da177e4
LT
560 .gendrv = {
561 .name = "sd",
3af6b352 562 .owner = THIS_MODULE,
1da177e4
LT
563 .probe = sd_probe,
564 .remove = sd_remove,
565 .shutdown = sd_shutdown,
691e3d31 566 .pm = &sd_pm_ops,
1da177e4
LT
567 },
568 .rescan = sd_rescan,
a1b73fc1
CH
569 .init_command = sd_init_command,
570 .uninit_command = sd_uninit_command,
7b3d9545 571 .done = sd_done,
18a4d0a2 572 .eh_action = sd_eh_action,
7a38dc0b 573 .eh_reset = sd_eh_reset,
1da177e4
LT
574};
575
0761df9c
HR
576/*
577 * Dummy kobj_map->probe function.
578 * The default ->probe function will call modprobe, which is
579 * pointless as this module is already loaded.
580 */
581static struct kobject *sd_default_probe(dev_t devt, int *partno, void *data)
582{
583 return NULL;
584}
585
1da177e4
LT
586/*
587 * Device no to disk mapping:
588 *
589 * major disc2 disc p1
590 * |............|.............|....|....| <- dev_t
591 * 31 20 19 8 7 4 3 0
592 *
593 * Inside a major, we have 16k disks, however mapped non-
594 * contiguously. The first 16 disks are for major0, the next
595 * ones with major1, ... Disk 256 is for major0 again, disk 272
596 * for major1, ...
597 * As we stay compatible with our numbering scheme, we can reuse
598 * the well-know SCSI majors 8, 65--71, 136--143.
599 */
600static int sd_major(int major_idx)
601{
602 switch (major_idx) {
603 case 0:
604 return SCSI_DISK0_MAJOR;
605 case 1 ... 7:
606 return SCSI_DISK1_MAJOR + major_idx - 1;
607 case 8 ... 15:
608 return SCSI_DISK8_MAJOR + major_idx - 8;
609 default:
610 BUG();
611 return 0; /* shut up gcc */
612 }
613}
614
3d9a1f53 615static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
1da177e4
LT
616{
617 struct scsi_disk *sdkp = NULL;
618
3d9a1f53
CH
619 mutex_lock(&sd_ref_mutex);
620
39b7f1e2
AS
621 if (disk->private_data) {
622 sdkp = scsi_disk(disk);
623 if (scsi_device_get(sdkp->device) == 0)
ee959b00 624 get_device(&sdkp->dev);
39b7f1e2
AS
625 else
626 sdkp = NULL;
627 }
0b950672 628 mutex_unlock(&sd_ref_mutex);
1da177e4
LT
629 return sdkp;
630}
631
632static void scsi_disk_put(struct scsi_disk *sdkp)
633{
634 struct scsi_device *sdev = sdkp->device;
635
0b950672 636 mutex_lock(&sd_ref_mutex);
ee959b00 637 put_device(&sdkp->dev);
1da177e4 638 scsi_device_put(sdev);
0b950672 639 mutex_unlock(&sd_ref_mutex);
1da177e4
LT
640}
641
d80210f2
CH
642#ifdef CONFIG_BLK_SED_OPAL
643static int sd_sec_submit(void *data, u16 spsp, u8 secp, void *buffer,
644 size_t len, bool send)
645{
646 struct scsi_device *sdev = data;
647 u8 cdb[12] = { 0, };
648 int ret;
649
650 cdb[0] = send ? SECURITY_PROTOCOL_OUT : SECURITY_PROTOCOL_IN;
651 cdb[1] = secp;
652 put_unaligned_be16(spsp, &cdb[2]);
653 put_unaligned_be32(len, &cdb[6]);
654
655 ret = scsi_execute_req(sdev, cdb,
656 send ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
657 buffer, len, NULL, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
658 return ret <= 0 ? ret : -EIO;
659}
660#endif /* CONFIG_BLK_SED_OPAL */
661
082c2cd2
JG
662/*
663 * Look up the DIX operation based on whether the command is read or
664 * write and whether dix and dif are enabled.
665 */
666static unsigned int sd_prot_op(bool write, bool dix, bool dif)
667{
668 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
669 static const unsigned int ops[] = { /* wrt dix dif */
670 SCSI_PROT_NORMAL, /* 0 0 0 */
671 SCSI_PROT_READ_STRIP, /* 0 0 1 */
672 SCSI_PROT_READ_INSERT, /* 0 1 0 */
673 SCSI_PROT_READ_PASS, /* 0 1 1 */
674 SCSI_PROT_NORMAL, /* 1 0 0 */
675 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
676 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
677 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
678 };
679
680 return ops[write << 2 | dix << 1 | dif];
681}
682
683/*
684 * Returns a mask of the protection flags that are valid for a given DIX
685 * operation.
686 */
687static unsigned int sd_prot_flag_mask(unsigned int prot_op)
688{
689 static const unsigned int flag_mask[] = {
690 [SCSI_PROT_NORMAL] = 0,
691
692 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
693 SCSI_PROT_GUARD_CHECK |
694 SCSI_PROT_REF_CHECK |
695 SCSI_PROT_REF_INCREMENT,
696
697 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
698 SCSI_PROT_IP_CHECKSUM,
699
700 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
701 SCSI_PROT_GUARD_CHECK |
702 SCSI_PROT_REF_CHECK |
703 SCSI_PROT_REF_INCREMENT |
704 SCSI_PROT_IP_CHECKSUM,
705
706 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
707 SCSI_PROT_REF_INCREMENT,
708
709 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
710 SCSI_PROT_REF_CHECK |
711 SCSI_PROT_REF_INCREMENT |
712 SCSI_PROT_IP_CHECKSUM,
713
714 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
715 SCSI_PROT_GUARD_CHECK |
716 SCSI_PROT_REF_CHECK |
717 SCSI_PROT_REF_INCREMENT |
718 SCSI_PROT_IP_CHECKSUM,
719 };
720
721 return flag_mask[prot_op];
722}
723
c611529e
MP
724static unsigned char sd_setup_protect_cmnd(struct scsi_cmnd *scmd,
725 unsigned int dix, unsigned int dif)
35e1a5d9 726{
c611529e
MP
727 struct bio *bio = scmd->request->bio;
728 unsigned int prot_op = sd_prot_op(rq_data_dir(scmd->request), dix, dif);
729 unsigned int protect = 0;
730
731 if (dix) { /* DIX Type 0, 1, 2, 3 */
732 if (bio_integrity_flagged(bio, BIP_IP_CHECKSUM))
733 scmd->prot_flags |= SCSI_PROT_IP_CHECKSUM;
734
735 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
736 scmd->prot_flags |= SCSI_PROT_GUARD_CHECK;
737 }
738
8475c811 739 if (dif != T10_PI_TYPE3_PROTECTION) { /* DIX/DIF Type 0, 1, 2 */
c611529e
MP
740 scmd->prot_flags |= SCSI_PROT_REF_INCREMENT;
741
742 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
743 scmd->prot_flags |= SCSI_PROT_REF_CHECK;
744 }
745
746 if (dif) { /* DIX/DIF Type 1, 2, 3 */
747 scmd->prot_flags |= SCSI_PROT_TRANSFER_PI;
748
749 if (bio_integrity_flagged(bio, BIP_DISK_NOCHECK))
750 protect = 3 << 5; /* Disable target PI checking */
751 else
752 protect = 1 << 5; /* Enable target PI checking */
35e1a5d9
MP
753 }
754
755 scsi_set_prot_op(scmd, prot_op);
756 scsi_set_prot_type(scmd, dif);
c611529e
MP
757 scmd->prot_flags &= sd_prot_flag_mask(prot_op);
758
759 return protect;
35e1a5d9
MP
760}
761
c98a0eb0
MP
762static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
763{
764 struct request_queue *q = sdkp->disk->queue;
765 unsigned int logical_block_size = sdkp->device->sector_size;
766 unsigned int max_blocks = 0;
767
bcd069bb
MP
768 q->limits.discard_alignment =
769 sdkp->unmap_alignment * logical_block_size;
770 q->limits.discard_granularity =
771 max(sdkp->physical_block_size,
772 sdkp->unmap_granularity * logical_block_size);
89730393
MP
773 sdkp->provisioning_mode = mode;
774
c98a0eb0
MP
775 switch (mode) {
776
4c11712a 777 case SD_LBP_FULL:
c98a0eb0 778 case SD_LBP_DISABLE:
2bb4cd5c 779 blk_queue_max_discard_sectors(q, 0);
8b904b5b 780 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
c98a0eb0
MP
781 return;
782
783 case SD_LBP_UNMAP:
5db44863
MP
784 max_blocks = min_not_zero(sdkp->max_unmap_blocks,
785 (u32)SD_MAX_WS16_BLOCKS);
c98a0eb0
MP
786 break;
787
788 case SD_LBP_WS16:
28a0bc41
MP
789 if (sdkp->device->unmap_limit_for_ws)
790 max_blocks = sdkp->max_unmap_blocks;
791 else
792 max_blocks = sdkp->max_ws_blocks;
793
794 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS16_BLOCKS);
c98a0eb0
MP
795 break;
796
797 case SD_LBP_WS10:
28a0bc41
MP
798 if (sdkp->device->unmap_limit_for_ws)
799 max_blocks = sdkp->max_unmap_blocks;
800 else
801 max_blocks = sdkp->max_ws_blocks;
802
803 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS10_BLOCKS);
c98a0eb0
MP
804 break;
805
806 case SD_LBP_ZERO:
5db44863
MP
807 max_blocks = min_not_zero(sdkp->max_ws_blocks,
808 (u32)SD_MAX_WS10_BLOCKS);
c98a0eb0
MP
809 break;
810 }
811
2bb4cd5c 812 blk_queue_max_discard_sectors(q, max_blocks * (logical_block_size >> 9));
8b904b5b 813 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
c98a0eb0
MP
814}
815
159b2cbf 816static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
e339c1a7 817{
6a7b4398 818 struct scsi_device *sdp = cmd->device;
81d926e8 819 struct request *rq = cmd->request;
c6c93fdd
MP
820 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
821 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
81d926e8 822 unsigned int data_len = 24;
c98a0eb0 823 char *buf;
e339c1a7 824
61cce6f6 825 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
81d926e8 826 if (!rq->special_vec.bv_page)
159b2cbf 827 return BLK_STS_RESOURCE;
61cce6f6 828 clear_highpage(rq->special_vec.bv_page);
81d926e8
CH
829 rq->special_vec.bv_offset = 0;
830 rq->special_vec.bv_len = data_len;
831 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
66ac0280 832
81d926e8
CH
833 cmd->cmd_len = 10;
834 cmd->cmnd[0] = UNMAP;
835 cmd->cmnd[8] = 24;
e339c1a7 836
81d926e8
CH
837 buf = page_address(rq->special_vec.bv_page);
838 put_unaligned_be16(6 + 16, &buf[0]);
839 put_unaligned_be16(16, &buf[2]);
c6c93fdd
MP
840 put_unaligned_be64(lba, &buf[8]);
841 put_unaligned_be32(nr_blocks, &buf[16]);
e339c1a7 842
81d926e8
CH
843 cmd->allowed = SD_MAX_RETRIES;
844 cmd->transfersize = data_len;
845 rq->timeout = SD_TIMEOUT;
846 scsi_req(rq)->resid_len = data_len;
e339c1a7 847
81d926e8
CH
848 return scsi_init_io(cmd);
849}
c98a0eb0 850
159b2cbf
CH
851static blk_status_t sd_setup_write_same16_cmnd(struct scsi_cmnd *cmd,
852 bool unmap)
81d926e8
CH
853{
854 struct scsi_device *sdp = cmd->device;
855 struct request *rq = cmd->request;
c6c93fdd
MP
856 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
857 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
81d926e8 858 u32 data_len = sdp->sector_size;
c98a0eb0 859
61cce6f6 860 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
81d926e8 861 if (!rq->special_vec.bv_page)
159b2cbf 862 return BLK_STS_RESOURCE;
61cce6f6 863 clear_highpage(rq->special_vec.bv_page);
81d926e8
CH
864 rq->special_vec.bv_offset = 0;
865 rq->special_vec.bv_len = data_len;
866 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
c98a0eb0 867
81d926e8
CH
868 cmd->cmd_len = 16;
869 cmd->cmnd[0] = WRITE_SAME_16;
02d26103 870 if (unmap)
6a7b4398 871 cmd->cmnd[1] = 0x8; /* UNMAP */
c6c93fdd
MP
872 put_unaligned_be64(lba, &cmd->cmnd[2]);
873 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
66ac0280 874
81d926e8
CH
875 cmd->allowed = SD_MAX_RETRIES;
876 cmd->transfersize = data_len;
02d26103 877 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
81d926e8 878 scsi_req(rq)->resid_len = data_len;
c98a0eb0 879
81d926e8
CH
880 return scsi_init_io(cmd);
881}
c98a0eb0 882
159b2cbf
CH
883static blk_status_t sd_setup_write_same10_cmnd(struct scsi_cmnd *cmd,
884 bool unmap)
81d926e8
CH
885{
886 struct scsi_device *sdp = cmd->device;
887 struct request *rq = cmd->request;
c6c93fdd
MP
888 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
889 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
81d926e8 890 u32 data_len = sdp->sector_size;
c98a0eb0 891
61cce6f6 892 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
81d926e8 893 if (!rq->special_vec.bv_page)
159b2cbf 894 return BLK_STS_RESOURCE;
61cce6f6 895 clear_highpage(rq->special_vec.bv_page);
81d926e8
CH
896 rq->special_vec.bv_offset = 0;
897 rq->special_vec.bv_len = data_len;
f9d03f96 898 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
e339c1a7 899
81d926e8
CH
900 cmd->cmd_len = 10;
901 cmd->cmnd[0] = WRITE_SAME;
902 if (unmap)
903 cmd->cmnd[1] = 0x8; /* UNMAP */
c6c93fdd
MP
904 put_unaligned_be32(lba, &cmd->cmnd[2]);
905 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
6a7b4398 906
e4200f8e 907 cmd->allowed = SD_MAX_RETRIES;
81d926e8 908 cmd->transfersize = data_len;
02d26103 909 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
81d926e8 910 scsi_req(rq)->resid_len = data_len;
6a7b4398 911
81d926e8 912 return scsi_init_io(cmd);
f1126e95 913}
f9d03f96 914
159b2cbf 915static blk_status_t sd_setup_write_zeroes_cmnd(struct scsi_cmnd *cmd)
02d26103
CH
916{
917 struct request *rq = cmd->request;
918 struct scsi_device *sdp = cmd->device;
919 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
c6c93fdd
MP
920 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
921 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
02d26103 922
e4b87837 923 if (!(rq->cmd_flags & REQ_NOUNMAP)) {
e6bd9312
MP
924 switch (sdkp->zeroing_mode) {
925 case SD_ZERO_WS16_UNMAP:
39051dd8 926 return sd_setup_write_same16_cmnd(cmd, true);
e6bd9312 927 case SD_ZERO_WS10_UNMAP:
39051dd8 928 return sd_setup_write_same10_cmnd(cmd, true);
e4b87837
CH
929 }
930 }
c98a0eb0 931
02d26103 932 if (sdp->no_write_same)
159b2cbf 933 return BLK_STS_TARGET;
ed44fd7f 934
c6c93fdd 935 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff)
39051dd8 936 return sd_setup_write_same16_cmnd(cmd, false);
ed44fd7f 937
39051dd8 938 return sd_setup_write_same10_cmnd(cmd, false);
f1126e95
FT
939}
940
5db44863
MP
941static void sd_config_write_same(struct scsi_disk *sdkp)
942{
943 struct request_queue *q = sdkp->disk->queue;
944 unsigned int logical_block_size = sdkp->device->sector_size;
5db44863
MP
945
946 if (sdkp->device->no_write_same) {
947 sdkp->max_ws_blocks = 0;
948 goto out;
949 }
950
951 /* Some devices can not handle block counts above 0xffff despite
952 * supporting WRITE SAME(16). Consequently we default to 64k
953 * blocks per I/O unless the device explicitly advertises a
954 * bigger limit.
955 */
66c28f97
MP
956 if (sdkp->max_ws_blocks > SD_MAX_WS10_BLOCKS)
957 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
958 (u32)SD_MAX_WS16_BLOCKS);
959 else if (sdkp->ws16 || sdkp->ws10 || sdkp->device->no_report_opcodes)
960 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
961 (u32)SD_MAX_WS10_BLOCKS);
962 else {
963 sdkp->device->no_write_same = 1;
964 sdkp->max_ws_blocks = 0;
965 }
5db44863 966
e6bd9312
MP
967 if (sdkp->lbprz && sdkp->lbpws)
968 sdkp->zeroing_mode = SD_ZERO_WS16_UNMAP;
969 else if (sdkp->lbprz && sdkp->lbpws10)
970 sdkp->zeroing_mode = SD_ZERO_WS10_UNMAP;
971 else if (sdkp->max_ws_blocks)
972 sdkp->zeroing_mode = SD_ZERO_WS;
973 else
974 sdkp->zeroing_mode = SD_ZERO_WRITE;
975
b7af62a9
DLM
976 if (sdkp->max_ws_blocks &&
977 sdkp->physical_block_size > logical_block_size) {
978 /*
979 * Reporting a maximum number of blocks that is not aligned
980 * on the device physical size would cause a large write same
981 * request to be split into physically unaligned chunks by
982 * __blkdev_issue_write_zeroes() and __blkdev_issue_write_same()
983 * even if the caller of these functions took care to align the
984 * large request. So make sure the maximum reported is aligned
985 * to the device physical block size. This is only an optional
986 * optimization for regular disks, but this is mandatory to
987 * avoid failure of large write same requests directed at
988 * sequential write required zones of host-managed ZBC disks.
989 */
990 sdkp->max_ws_blocks =
991 round_down(sdkp->max_ws_blocks,
992 bytes_to_logical(sdkp->device,
993 sdkp->physical_block_size));
994 }
995
5db44863 996out:
66c28f97
MP
997 blk_queue_max_write_same_sectors(q, sdkp->max_ws_blocks *
998 (logical_block_size >> 9));
02d26103
CH
999 blk_queue_max_write_zeroes_sectors(q, sdkp->max_ws_blocks *
1000 (logical_block_size >> 9));
5db44863
MP
1001}
1002
1003/**
1004 * sd_setup_write_same_cmnd - write the same data to multiple blocks
59b1134c 1005 * @cmd: command to prepare
5db44863 1006 *
7529fbb0
DLM
1007 * Will set up either WRITE SAME(10) or WRITE SAME(16) depending on
1008 * the preference indicated by the target device.
5db44863 1009 **/
159b2cbf 1010static blk_status_t sd_setup_write_same_cmnd(struct scsi_cmnd *cmd)
5db44863 1011{
59b1134c
CH
1012 struct request *rq = cmd->request;
1013 struct scsi_device *sdp = cmd->device;
5db44863
MP
1014 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1015 struct bio *bio = rq->bio;
c6c93fdd
MP
1016 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
1017 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
159b2cbf 1018 blk_status_t ret;
5db44863
MP
1019
1020 if (sdkp->device->no_write_same)
159b2cbf 1021 return BLK_STS_TARGET;
5db44863 1022
a4ad39b1 1023 BUG_ON(bio_offset(bio) || bio_iovec(bio).bv_len != sdp->sector_size);
5db44863 1024
5db44863 1025 rq->timeout = SD_WRITE_SAME_TIMEOUT;
5db44863 1026
c6c93fdd 1027 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff) {
59b1134c
CH
1028 cmd->cmd_len = 16;
1029 cmd->cmnd[0] = WRITE_SAME_16;
c6c93fdd
MP
1030 put_unaligned_be64(lba, &cmd->cmnd[2]);
1031 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
5db44863 1032 } else {
59b1134c
CH
1033 cmd->cmd_len = 10;
1034 cmd->cmnd[0] = WRITE_SAME;
c6c93fdd
MP
1035 put_unaligned_be32(lba, &cmd->cmnd[2]);
1036 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
5db44863
MP
1037 }
1038
59b1134c 1039 cmd->transfersize = sdp->sector_size;
a25ee548 1040 cmd->allowed = SD_MAX_RETRIES;
08965c2e
BVA
1041
1042 /*
1043 * For WRITE SAME the data transferred via the DATA OUT buffer is
1044 * different from the amount of data actually written to the target.
1045 *
1046 * We set up __data_len to the amount of data transferred via the
1047 * DATA OUT buffer so that blk_rq_map_sg sets up the proper S/G list
1048 * to transfer a single sector of data first, but then reset it to
1049 * the amount of data to be written right after so that the I/O path
1050 * knows how much to actually write.
1051 */
1052 rq->__data_len = sdp->sector_size;
1053 ret = scsi_init_io(cmd);
84f7a9de 1054 rq->__data_len = blk_rq_bytes(rq);
29f6ca69 1055
08965c2e 1056 return ret;
5db44863
MP
1057}
1058
159b2cbf 1059static blk_status_t sd_setup_flush_cmnd(struct scsi_cmnd *cmd)
90467c29 1060{
a118c6c1
CH
1061 struct request *rq = cmd->request;
1062
1063 /* flush requests don't perform I/O, zero the S/G table */
1064 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
90467c29 1065
a118c6c1
CH
1066 cmd->cmnd[0] = SYNCHRONIZE_CACHE;
1067 cmd->cmd_len = 10;
1068 cmd->transfersize = 0;
1069 cmd->allowed = SD_MAX_RETRIES;
1070
26b9fd8b 1071 rq->timeout = rq->q->rq_timeout * SD_FLUSH_TIMEOUT_MULTIPLIER;
159b2cbf 1072 return BLK_STS_OK;
90467c29
FT
1073}
1074
78a02f49
MP
1075static blk_status_t sd_setup_rw32_cmnd(struct scsi_cmnd *cmd, bool write,
1076 sector_t lba, unsigned int nr_blocks,
1077 unsigned char flags)
1078{
1079 cmd->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
1080 if (unlikely(cmd->cmnd == NULL))
1081 return BLK_STS_RESOURCE;
1082
1083 cmd->cmd_len = SD_EXT_CDB_SIZE;
1084 memset(cmd->cmnd, 0, cmd->cmd_len);
1085
1086 cmd->cmnd[0] = VARIABLE_LENGTH_CMD;
1087 cmd->cmnd[7] = 0x18; /* Additional CDB len */
1088 cmd->cmnd[9] = write ? WRITE_32 : READ_32;
1089 cmd->cmnd[10] = flags;
1090 put_unaligned_be64(lba, &cmd->cmnd[12]);
1091 put_unaligned_be32(lba, &cmd->cmnd[20]); /* Expected Indirect LBA */
1092 put_unaligned_be32(nr_blocks, &cmd->cmnd[28]);
1093
1094 return BLK_STS_OK;
1095}
1096
1097static blk_status_t sd_setup_rw16_cmnd(struct scsi_cmnd *cmd, bool write,
1098 sector_t lba, unsigned int nr_blocks,
1099 unsigned char flags)
1100{
1101 cmd->cmd_len = 16;
1102 cmd->cmnd[0] = write ? WRITE_16 : READ_16;
1103 cmd->cmnd[1] = flags;
1104 cmd->cmnd[14] = 0;
1105 cmd->cmnd[15] = 0;
1106 put_unaligned_be64(lba, &cmd->cmnd[2]);
1107 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
1108
1109 return BLK_STS_OK;
1110}
1111
1112static blk_status_t sd_setup_rw10_cmnd(struct scsi_cmnd *cmd, bool write,
1113 sector_t lba, unsigned int nr_blocks,
1114 unsigned char flags)
1115{
1116 cmd->cmd_len = 10;
1117 cmd->cmnd[0] = write ? WRITE_10 : READ_10;
1118 cmd->cmnd[1] = flags;
1119 cmd->cmnd[6] = 0;
1120 cmd->cmnd[9] = 0;
1121 put_unaligned_be32(lba, &cmd->cmnd[2]);
1122 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
1123
1124 return BLK_STS_OK;
1125}
1126
1127static blk_status_t sd_setup_rw6_cmnd(struct scsi_cmnd *cmd, bool write,
1128 sector_t lba, unsigned int nr_blocks,
1129 unsigned char flags)
1130{
1131 if (unlikely(flags & 0x8)) {
1132 /*
1133 * This happens only if this drive failed 10byte rw
1134 * command with ILLEGAL_REQUEST during operation and
1135 * thus turned off use_10_for_rw.
1136 */
1137 scmd_printk(KERN_ERR, cmd, "FUA write on READ/WRITE(6) drive\n");
1138 return BLK_STS_IOERR;
1139 }
1140
1141 cmd->cmd_len = 6;
1142 cmd->cmnd[0] = write ? WRITE_6 : READ_6;
1143 cmd->cmnd[1] = (lba >> 16) & 0x1f;
1144 cmd->cmnd[2] = (lba >> 8) & 0xff;
1145 cmd->cmnd[3] = lba & 0xff;
1146 cmd->cmnd[4] = nr_blocks;
1147 cmd->cmnd[5] = 0;
1148
1149 return BLK_STS_OK;
1150}
1151
159b2cbf 1152static blk_status_t sd_setup_read_write_cmnd(struct scsi_cmnd *SCpnt)
1da177e4 1153{
a1b73fc1
CH
1154 struct request *rq = SCpnt->request;
1155 struct scsi_device *sdp = SCpnt->device;
776b23a0 1156 struct gendisk *disk = rq->rq_disk;
89d94756 1157 struct scsi_disk *sdkp = scsi_disk(disk);
ec029758 1158 sector_t lba = sectors_to_logical(sdp, blk_rq_pos(rq));
18351070 1159 sector_t threshold;
ec029758 1160 unsigned int nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
c611529e 1161 unsigned int dif, dix;
ec029758 1162 unsigned int mask = logical_to_sectors(sdp, 1) - 1;
78a02f49
MP
1163 bool write = rq_data_dir(rq) == WRITE;
1164 unsigned char protect, fua;
159b2cbf 1165 blk_status_t ret;
7f9a6bc4 1166
3c356bde 1167 ret = scsi_init_io(SCpnt);
159b2cbf 1168 if (ret != BLK_STS_OK)
39051dd8 1169 return ret;
0624cbb1 1170 WARN_ON_ONCE(SCpnt != rq->special);
7f9a6bc4 1171
a1b73fc1
CH
1172 SCSI_LOG_HLQUEUE(1,
1173 scmd_printk(KERN_INFO, SCpnt,
1174 "%s: block=%llu, count=%d\n",
c6c93fdd 1175 __func__, (unsigned long long)lba, nr_blocks));
1da177e4
LT
1176
1177 if (!sdp || !scsi_device_online(sdp) ||
c6c93fdd 1178 lba + blk_rq_sectors(rq) > get_capacity(disk)) {
fa0d34be 1179 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
83096ebf
TH
1180 "Finishing %u sectors\n",
1181 blk_rq_sectors(rq)));
fa0d34be
MP
1182 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
1183 "Retry with 0x%p\n", SCpnt));
159b2cbf 1184 return BLK_STS_IOERR;
1da177e4
LT
1185 }
1186
1187 if (sdp->changed) {
1188 /*
1189 * quietly refuse to do anything to a changed disc until
1190 * the changed bit has been reset
1191 */
3ff5588d 1192 /* printk("SCSI disk has been changed or is not present. Prohibiting further I/O.\n"); */
159b2cbf 1193 return BLK_STS_IOERR;
1da177e4 1194 }
7f9a6bc4 1195
a0899d4d 1196 /*
ec029758
MP
1197 * Some SD card readers can't handle accesses which touch the
1198 * last one or two logical blocks. Split accesses as needed.
a0899d4d 1199 */
ec029758 1200 threshold = sdkp->capacity - SD_LAST_BUGGY_SECTORS;
18351070 1201
c6c93fdd
MP
1202 if (unlikely(sdp->last_sector_bug && lba + nr_blocks > threshold)) {
1203 if (lba < threshold) {
18351070 1204 /* Access up to the threshold but not beyond */
c6c93fdd 1205 nr_blocks = threshold - lba;
18351070 1206 } else {
ec029758
MP
1207 /* Access only a single logical block */
1208 nr_blocks = 1;
18351070
LT
1209 }
1210 }
a0899d4d 1211
fa0d34be 1212 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
c6c93fdd 1213 (unsigned long long)lba));
1da177e4 1214
ec029758
MP
1215 if ((blk_rq_pos(rq) & mask) || (blk_rq_sectors(rq) & mask)) {
1216 scmd_printk(KERN_ERR, SCpnt, "request not aligned to the logical block size\n");
1217 return BLK_STS_IOERR;
1da177e4 1218 }
ec029758 1219
1da177e4 1220 if (rq_data_dir(rq) == WRITE) {
1da177e4 1221 SCpnt->cmnd[0] = WRITE_6;
af55ff67 1222
8c579ab6 1223 if (blk_integrity_rq(rq))
10c41ddd 1224 t10_pi_prepare(SCpnt->request, sdkp->protection_type);
af55ff67 1225
1da177e4
LT
1226 } else if (rq_data_dir(rq) == READ) {
1227 SCpnt->cmnd[0] = READ_6;
1da177e4 1228 } else {
ef295ecf 1229 scmd_printk(KERN_ERR, SCpnt, "Unknown command %d\n", req_op(rq));
159b2cbf 1230 return BLK_STS_IOERR;
1da177e4
LT
1231 }
1232
fa0d34be 1233 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
83096ebf 1234 "%s %d/%u 512 byte blocks.\n",
fa0d34be 1235 (rq_data_dir(rq) == WRITE) ?
c6c93fdd 1236 "writing" : "reading", nr_blocks,
83096ebf 1237 blk_rq_sectors(rq)));
1da177e4 1238
78a02f49 1239 fua = rq->cmd_flags & REQ_FUA ? 0x8 : 0;
c611529e
MP
1240 dix = scsi_prot_sg_count(SCpnt);
1241 dif = scsi_host_dif_capable(SCpnt->device->host, sdkp->protection_type);
1242
1243 if (dif || dix)
1244 protect = sd_setup_protect_cmnd(SCpnt, dix, dif);
af55ff67 1245 else
4e7392ec
MP
1246 protect = 0;
1247
8475c811 1248 if (protect && sdkp->protection_type == T10_PI_TYPE2_PROTECTION) {
78a02f49
MP
1249 ret = sd_setup_rw32_cmnd(SCpnt, write, lba, nr_blocks,
1250 protect | fua);
c6c93fdd 1251 } else if (sdp->use_16_for_rw || (nr_blocks > 0xffff)) {
78a02f49
MP
1252 ret = sd_setup_rw16_cmnd(SCpnt, write, lba, nr_blocks,
1253 protect | fua);
c6c93fdd 1254 } else if ((nr_blocks > 0xff) || (lba > 0x1fffff) ||
af55ff67 1255 scsi_device_protection(SCpnt->device) ||
1da177e4 1256 SCpnt->device->use_10_for_rw) {
78a02f49
MP
1257 ret = sd_setup_rw10_cmnd(SCpnt, write, lba, nr_blocks,
1258 protect | fua);
1da177e4 1259 } else {
78a02f49
MP
1260 ret = sd_setup_rw6_cmnd(SCpnt, write, lba, nr_blocks,
1261 protect | fua);
1da177e4 1262 }
78a02f49
MP
1263
1264 if (unlikely(ret != BLK_STS_OK))
1265 return ret;
1266
c6c93fdd 1267 SCpnt->sdb.length = nr_blocks * sdp->sector_size;
1da177e4
LT
1268
1269 /*
1270 * We shouldn't disconnect in the middle of a sector, so with a dumb
1271 * host adapter, it's safe to assume that we can at least transfer
1272 * this many bytes between each connect / disconnect.
1273 */
1274 SCpnt->transfersize = sdp->sector_size;
c6c93fdd 1275 SCpnt->underflow = nr_blocks << 9;
1da177e4 1276 SCpnt->allowed = SD_MAX_RETRIES;
1da177e4 1277
1da177e4
LT
1278 /*
1279 * This indicates that the command is ready from our end to be
1280 * queued.
1281 */
159b2cbf 1282 return BLK_STS_OK;
1da177e4
LT
1283}
1284
159b2cbf 1285static blk_status_t sd_init_command(struct scsi_cmnd *cmd)
87949eee
CH
1286{
1287 struct request *rq = cmd->request;
1288
c2df40df
MC
1289 switch (req_op(rq)) {
1290 case REQ_OP_DISCARD:
81d926e8
CH
1291 switch (scsi_disk(rq->rq_disk)->provisioning_mode) {
1292 case SD_LBP_UNMAP:
1293 return sd_setup_unmap_cmnd(cmd);
1294 case SD_LBP_WS16:
02d26103 1295 return sd_setup_write_same16_cmnd(cmd, true);
81d926e8
CH
1296 case SD_LBP_WS10:
1297 return sd_setup_write_same10_cmnd(cmd, true);
1298 case SD_LBP_ZERO:
1299 return sd_setup_write_same10_cmnd(cmd, false);
1300 default:
159b2cbf 1301 return BLK_STS_TARGET;
81d926e8 1302 }
02d26103
CH
1303 case REQ_OP_WRITE_ZEROES:
1304 return sd_setup_write_zeroes_cmnd(cmd);
c2df40df 1305 case REQ_OP_WRITE_SAME:
87949eee 1306 return sd_setup_write_same_cmnd(cmd);
3a5e02ce 1307 case REQ_OP_FLUSH:
87949eee 1308 return sd_setup_flush_cmnd(cmd);
c2df40df
MC
1309 case REQ_OP_READ:
1310 case REQ_OP_WRITE:
87949eee 1311 return sd_setup_read_write_cmnd(cmd);
89d94756
HR
1312 case REQ_OP_ZONE_RESET:
1313 return sd_zbc_setup_reset_cmnd(cmd);
c2df40df 1314 default:
f1f1fada 1315 WARN_ON_ONCE(1);
159b2cbf 1316 return BLK_STS_NOTSUPP;
c2df40df 1317 }
87949eee
CH
1318}
1319
1320static void sd_uninit_command(struct scsi_cmnd *SCpnt)
1321{
1322 struct request *rq = SCpnt->request;
14e3062f 1323 u8 *cmnd;
87949eee 1324
f9d03f96 1325 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
61cce6f6 1326 mempool_free(rq->special_vec.bv_page, sd_page_pool);
87949eee 1327
82ed4db4 1328 if (SCpnt->cmnd != scsi_req(rq)->cmd) {
14e3062f 1329 cmnd = SCpnt->cmnd;
87949eee
CH
1330 SCpnt->cmnd = NULL;
1331 SCpnt->cmd_len = 0;
14e3062f 1332 mempool_free(cmnd, sd_cdb_pool);
87949eee
CH
1333 }
1334}
1335
1da177e4
LT
1336/**
1337 * sd_open - open a scsi disk device
7529fbb0
DLM
1338 * @bdev: Block device of the scsi disk to open
1339 * @mode: FMODE_* mask
1da177e4
LT
1340 *
1341 * Returns 0 if successful. Returns a negated errno value in case
1342 * of error.
1343 *
1344 * Note: This can be called from a user context (e.g. fsck(1) )
1345 * or from within the kernel (e.g. as a result of a mount(1) ).
1346 * In the latter case @inode and @filp carry an abridged amount
1347 * of information as noted above.
409f3499
AB
1348 *
1349 * Locking: called with bdev->bd_mutex held.
1da177e4 1350 **/
0338e291 1351static int sd_open(struct block_device *bdev, fmode_t mode)
1da177e4 1352{
0338e291 1353 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
1da177e4
LT
1354 struct scsi_device *sdev;
1355 int retval;
1356
0338e291 1357 if (!sdkp)
1da177e4
LT
1358 return -ENXIO;
1359
fa0d34be 1360 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
1da177e4
LT
1361
1362 sdev = sdkp->device;
1363
1364 /*
1365 * If the device is in error recovery, wait until it is done.
1366 * If the device is offline, then disallow any access to it.
1367 */
1368 retval = -ENXIO;
1369 if (!scsi_block_when_processing_errors(sdev))
1370 goto error_out;
1371
1372 if (sdev->removable || sdkp->write_prot)
0338e291 1373 check_disk_change(bdev);
1da177e4
LT
1374
1375 /*
1376 * If the drive is empty, just let the open fail.
1377 */
1378 retval = -ENOMEDIUM;
0338e291 1379 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
1da177e4
LT
1380 goto error_out;
1381
1382 /*
1383 * If the device has the write protect tab set, have the open fail
1384 * if the user expects to be able to write to the thing.
1385 */
1386 retval = -EROFS;
0338e291 1387 if (sdkp->write_prot && (mode & FMODE_WRITE))
1da177e4
LT
1388 goto error_out;
1389
1390 /*
1391 * It is possible that the disk changing stuff resulted in
1392 * the device being taken offline. If this is the case,
1393 * report this to the user, and don't pretend that the
1394 * open actually succeeded.
1395 */
1396 retval = -ENXIO;
1397 if (!scsi_device_online(sdev))
1398 goto error_out;
1399
409f3499 1400 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
1da177e4
LT
1401 if (scsi_block_when_processing_errors(sdev))
1402 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1403 }
1404
1405 return 0;
1406
1407error_out:
1408 scsi_disk_put(sdkp);
1409 return retval;
1410}
1411
1412/**
1413 * sd_release - invoked when the (last) close(2) is called on this
1414 * scsi disk.
7529fbb0
DLM
1415 * @disk: disk to release
1416 * @mode: FMODE_* mask
1da177e4
LT
1417 *
1418 * Returns 0.
1419 *
1420 * Note: may block (uninterruptible) if error recovery is underway
1421 * on this disk.
409f3499
AB
1422 *
1423 * Locking: called with bdev->bd_mutex held.
1da177e4 1424 **/
db2a144b 1425static void sd_release(struct gendisk *disk, fmode_t mode)
1da177e4 1426{
1da177e4
LT
1427 struct scsi_disk *sdkp = scsi_disk(disk);
1428 struct scsi_device *sdev = sdkp->device;
1429
56937f7b 1430 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1da177e4 1431
7e443312 1432 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
1da177e4
LT
1433 if (scsi_block_when_processing_errors(sdev))
1434 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1435 }
1436
1437 /*
1438 * XXX and what if there are packets in flight and this close()
1439 * XXX is followed by a "rmmod sd_mod"?
1440 */
478a8a05 1441
1da177e4 1442 scsi_disk_put(sdkp);
1da177e4
LT
1443}
1444
a885c8c4 1445static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1da177e4
LT
1446{
1447 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1448 struct scsi_device *sdp = sdkp->device;
1449 struct Scsi_Host *host = sdp->host;
f08bb1e0 1450 sector_t capacity = logical_to_sectors(sdp, sdkp->capacity);
1da177e4
LT
1451 int diskinfo[4];
1452
1453 /* default to most commonly used values */
f08bb1e0
MP
1454 diskinfo[0] = 0x40; /* 1 << 6 */
1455 diskinfo[1] = 0x20; /* 1 << 5 */
1456 diskinfo[2] = capacity >> 11;
1457
1da177e4
LT
1458 /* override with calculated, extended default, or driver values */
1459 if (host->hostt->bios_param)
f08bb1e0 1460 host->hostt->bios_param(sdp, bdev, capacity, diskinfo);
1da177e4 1461 else
f08bb1e0 1462 scsicam_bios_param(bdev, capacity, diskinfo);
1da177e4 1463
a885c8c4
CH
1464 geo->heads = diskinfo[0];
1465 geo->sectors = diskinfo[1];
1466 geo->cylinders = diskinfo[2];
1da177e4
LT
1467 return 0;
1468}
1469
1470/**
1471 * sd_ioctl - process an ioctl
7529fbb0
DLM
1472 * @bdev: target block device
1473 * @mode: FMODE_* mask
1da177e4
LT
1474 * @cmd: ioctl command number
1475 * @arg: this is third argument given to ioctl(2) system call.
1476 * Often contains a pointer.
1477 *
25985edc 1478 * Returns 0 if successful (some ioctls return positive numbers on
1da177e4
LT
1479 * success as well). Returns a negated errno value in case of error.
1480 *
1481 * Note: most ioctls are forward onto the block subsystem or further
3a4fa0a2 1482 * down in the scsi subsystem.
1da177e4 1483 **/
0338e291 1484static int sd_ioctl(struct block_device *bdev, fmode_t mode,
1da177e4
LT
1485 unsigned int cmd, unsigned long arg)
1486{
1da177e4 1487 struct gendisk *disk = bdev->bd_disk;
fe2d1851
NN
1488 struct scsi_disk *sdkp = scsi_disk(disk);
1489 struct scsi_device *sdp = sdkp->device;
1da177e4
LT
1490 void __user *p = (void __user *)arg;
1491 int error;
1492
fe2d1851
NN
1493 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1494 "cmd=0x%x\n", disk->disk_name, cmd));
1da177e4 1495
0bfc96cb
PB
1496 error = scsi_verify_blk_ioctl(bdev, cmd);
1497 if (error < 0)
1498 return error;
1499
1da177e4
LT
1500 /*
1501 * If we are in the middle of error recovery, don't let anyone
1502 * else try and use this device. Also, if error recovery fails, it
1503 * may try and take the device offline, in which case all further
1504 * access to the device is prohibited.
1505 */
906d15fb
CH
1506 error = scsi_ioctl_block_when_processing_errors(sdp, cmd,
1507 (mode & FMODE_NDELAY) != 0);
1508 if (error)
8a6cfeb6 1509 goto out;
1da177e4 1510
d80210f2
CH
1511 if (is_sed_ioctl(cmd))
1512 return sed_ioctl(sdkp->opal_dev, cmd, p);
1513
1da177e4
LT
1514 /*
1515 * Send SCSI addressing ioctls directly to mid level, send other
1516 * ioctls to block level and then onto mid level if they can't be
1517 * resolved.
1518 */
1519 switch (cmd) {
1520 case SCSI_IOCTL_GET_IDLUN:
1521 case SCSI_IOCTL_GET_BUS_NUMBER:
8a6cfeb6
AB
1522 error = scsi_ioctl(sdp, cmd, p);
1523 break;
1da177e4 1524 default:
577ebb37 1525 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
1da177e4 1526 if (error != -ENOTTY)
8a6cfeb6
AB
1527 break;
1528 error = scsi_ioctl(sdp, cmd, p);
1529 break;
1da177e4 1530 }
8a6cfeb6 1531out:
8a6cfeb6 1532 return error;
1da177e4
LT
1533}
1534
1535static void set_media_not_present(struct scsi_disk *sdkp)
1536{
2bae0093
TH
1537 if (sdkp->media_present)
1538 sdkp->device->changed = 1;
1539
1540 if (sdkp->device->removable) {
1541 sdkp->media_present = 0;
1542 sdkp->capacity = 0;
1543 }
1544}
1545
1546static int media_not_present(struct scsi_disk *sdkp,
1547 struct scsi_sense_hdr *sshdr)
1548{
1549 if (!scsi_sense_valid(sshdr))
1550 return 0;
1551
1552 /* not invoked for commands that could return deferred errors */
1553 switch (sshdr->sense_key) {
1554 case UNIT_ATTENTION:
1555 case NOT_READY:
1556 /* medium not present */
1557 if (sshdr->asc == 0x3A) {
1558 set_media_not_present(sdkp);
1559 return 1;
1560 }
1561 }
1562 return 0;
1da177e4
LT
1563}
1564
1565/**
2bae0093
TH
1566 * sd_check_events - check media events
1567 * @disk: kernel device descriptor
1568 * @clearing: disk events currently being cleared
1da177e4 1569 *
2bae0093 1570 * Returns mask of DISK_EVENT_*.
1da177e4
LT
1571 *
1572 * Note: this function is invoked from the block subsystem.
1573 **/
2bae0093 1574static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
1da177e4 1575{
eb72d0bb
HR
1576 struct scsi_disk *sdkp = scsi_disk_get(disk);
1577 struct scsi_device *sdp;
1da177e4
LT
1578 int retval;
1579
eb72d0bb
HR
1580 if (!sdkp)
1581 return 0;
1582
1583 sdp = sdkp->device;
2bae0093 1584 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
1da177e4
LT
1585
1586 /*
1587 * If the device is offline, don't send any commands - just pretend as
1588 * if the command failed. If the device ever comes back online, we
1589 * can deal with it then. It is only because of unrecoverable errors
1590 * that we would ever take a device offline in the first place.
1591 */
285e9670
KS
1592 if (!scsi_device_online(sdp)) {
1593 set_media_not_present(sdkp);
285e9670
KS
1594 goto out;
1595 }
1da177e4
LT
1596
1597 /*
1598 * Using TEST_UNIT_READY enables differentiation between drive with
1599 * no cartridge loaded - NOT READY, drive with changed cartridge -
1600 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1601 *
1602 * Drives that auto spin down. eg iomega jaz 1G, will be started
1603 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1604 * sd_revalidate() is called.
1605 */
001aac25 1606 if (scsi_block_when_processing_errors(sdp)) {
6fa2b8f9
CH
1607 struct scsi_sense_hdr sshdr = { 0, };
1608
001aac25 1609 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
6fa2b8f9 1610 &sshdr);
1da177e4 1611
6fa2b8f9
CH
1612 /* failed to execute TUR, assume media not present */
1613 if (host_byte(retval)) {
1614 set_media_not_present(sdkp);
1615 goto out;
1616 }
1da177e4 1617
6fa2b8f9
CH
1618 if (media_not_present(sdkp, &sshdr))
1619 goto out;
1620 }
2bae0093 1621
1da177e4
LT
1622 /*
1623 * For removable scsi disk we have to recognise the presence
2bae0093 1624 * of a disk in the drive.
1da177e4 1625 */
2bae0093
TH
1626 if (!sdkp->media_present)
1627 sdp->changed = 1;
1da177e4 1628 sdkp->media_present = 1;
285e9670 1629out:
3ff5588d 1630 /*
2bae0093 1631 * sdp->changed is set under the following conditions:
3ff5588d 1632 *
2bae0093
TH
1633 * Medium present state has changed in either direction.
1634 * Device has indicated UNIT_ATTENTION.
3ff5588d 1635 */
2bae0093
TH
1636 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1637 sdp->changed = 0;
eb72d0bb 1638 scsi_disk_put(sdkp);
1da177e4 1639 return retval;
1da177e4
LT
1640}
1641
4fa83244 1642static int sd_sync_cache(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
1da177e4 1643{
1da177e4 1644 int retries, res;
e73aec82 1645 struct scsi_device *sdp = sdkp->device;
7e660100
JB
1646 const int timeout = sdp->request_queue->rq_timeout
1647 * SD_FLUSH_TIMEOUT_MULTIPLIER;
4fa83244 1648 struct scsi_sense_hdr my_sshdr;
1da177e4
LT
1649
1650 if (!scsi_device_online(sdp))
1651 return -ENODEV;
1652
4fa83244
DB
1653 /* caller might not be interested in sense, but we need it */
1654 if (!sshdr)
1655 sshdr = &my_sshdr;
1656
1da177e4
LT
1657 for (retries = 3; retries > 0; --retries) {
1658 unsigned char cmd[10] = { 0 };
1659
1660 cmd[0] = SYNCHRONIZE_CACHE;
1661 /*
1662 * Leave the rest of the command zero to indicate
1663 * flush everything.
1664 */
4fa83244 1665 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, sshdr,
fcbfffe2 1666 timeout, SD_MAX_RETRIES, 0, RQF_PM, NULL);
ea73a9f2 1667 if (res == 0)
1da177e4
LT
1668 break;
1669 }
1670
e73aec82 1671 if (res) {
ef61329d 1672 sd_print_result(sdkp, "Synchronize Cache(10) failed", res);
95897910 1673
c65be1a6 1674 if (driver_byte(res) == DRIVER_SENSE)
4fa83244
DB
1675 sd_print_sense_hdr(sdkp, sshdr);
1676
95897910 1677 /* we need to evaluate the error return */
4fa83244
DB
1678 if (scsi_sense_valid(sshdr) &&
1679 (sshdr->asc == 0x3a || /* medium not present */
1680 sshdr->asc == 0x20)) /* invalid command */
95897910
ON
1681 /* this is no error here */
1682 return 0;
1683
1684 switch (host_byte(res)) {
1685 /* ignore errors due to racing a disconnection */
1686 case DID_BAD_TARGET:
1687 case DID_NO_CONNECT:
1688 return 0;
1689 /* signal the upper layer it might try again */
1690 case DID_BUS_BUSY:
1691 case DID_IMM_RETRY:
1692 case DID_REQUEUE:
1693 case DID_SOFT_ERROR:
1694 return -EBUSY;
1695 default:
1696 return -EIO;
1697 }
1da177e4 1698 }
3721050a 1699 return 0;
1da177e4
LT
1700}
1701
1da177e4
LT
1702static void sd_rescan(struct device *dev)
1703{
3d9a1f53 1704 struct scsi_disk *sdkp = dev_get_drvdata(dev);
39b7f1e2 1705
3d9a1f53 1706 revalidate_disk(sdkp->disk);
1da177e4
LT
1707}
1708
1709
1710#ifdef CONFIG_COMPAT
1711/*
1712 * This gets directly called from VFS. When the ioctl
1713 * is not recognized we go back to the other translation paths.
1714 */
0338e291
AV
1715static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1716 unsigned int cmd, unsigned long arg)
1da177e4 1717{
0338e291 1718 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
21a9d4c9 1719 int error;
1da177e4 1720
21a9d4c9
CH
1721 error = scsi_ioctl_block_when_processing_errors(sdev, cmd,
1722 (mode & FMODE_NDELAY) != 0);
1723 if (error)
1724 return error;
1da177e4 1725
1da177e4
LT
1726 /*
1727 * Let the static ioctl translation table take care of it.
1728 */
21a9d4c9
CH
1729 if (!sdev->host->hostt->compat_ioctl)
1730 return -ENOIOCTLCMD;
1731 return sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
1da177e4
LT
1732}
1733#endif
1734
924d55b0
CH
1735static char sd_pr_type(enum pr_type type)
1736{
1737 switch (type) {
1738 case PR_WRITE_EXCLUSIVE:
1739 return 0x01;
1740 case PR_EXCLUSIVE_ACCESS:
1741 return 0x03;
1742 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1743 return 0x05;
1744 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1745 return 0x06;
1746 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1747 return 0x07;
1748 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1749 return 0x08;
1750 default:
1751 return 0;
1752 }
1753};
1754
1755static int sd_pr_command(struct block_device *bdev, u8 sa,
1756 u64 key, u64 sa_key, u8 type, u8 flags)
1757{
1758 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1759 struct scsi_sense_hdr sshdr;
1760 int result;
1761 u8 cmd[16] = { 0, };
1762 u8 data[24] = { 0, };
1763
1764 cmd[0] = PERSISTENT_RESERVE_OUT;
1765 cmd[1] = sa;
1766 cmd[2] = type;
1767 put_unaligned_be32(sizeof(data), &cmd[5]);
1768
1769 put_unaligned_be64(key, &data[0]);
1770 put_unaligned_be64(sa_key, &data[8]);
1771 data[20] = flags;
1772
1773 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, &data, sizeof(data),
1774 &sshdr, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1775
c65be1a6
JT
1776 if (driver_byte(result) == DRIVER_SENSE &&
1777 scsi_sense_valid(&sshdr)) {
924d55b0
CH
1778 sdev_printk(KERN_INFO, sdev, "PR command failed: %d\n", result);
1779 scsi_print_sense_hdr(sdev, NULL, &sshdr);
1780 }
1781
1782 return result;
1783}
1784
1785static int sd_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
1786 u32 flags)
1787{
1788 if (flags & ~PR_FL_IGNORE_KEY)
1789 return -EOPNOTSUPP;
1790 return sd_pr_command(bdev, (flags & PR_FL_IGNORE_KEY) ? 0x06 : 0x00,
1791 old_key, new_key, 0,
01f90dd9 1792 (1 << 0) /* APTPL */);
924d55b0
CH
1793}
1794
1795static int sd_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
1796 u32 flags)
1797{
1798 if (flags)
1799 return -EOPNOTSUPP;
1800 return sd_pr_command(bdev, 0x01, key, 0, sd_pr_type(type), 0);
1801}
1802
1803static int sd_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1804{
1805 return sd_pr_command(bdev, 0x02, key, 0, sd_pr_type(type), 0);
1806}
1807
1808static int sd_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
1809 enum pr_type type, bool abort)
1810{
1811 return sd_pr_command(bdev, abort ? 0x05 : 0x04, old_key, new_key,
1812 sd_pr_type(type), 0);
1813}
1814
1815static int sd_pr_clear(struct block_device *bdev, u64 key)
1816{
1817 return sd_pr_command(bdev, 0x03, key, 0, 0, 0);
1818}
1819
1820static const struct pr_ops sd_pr_ops = {
1821 .pr_register = sd_pr_register,
1822 .pr_reserve = sd_pr_reserve,
1823 .pr_release = sd_pr_release,
1824 .pr_preempt = sd_pr_preempt,
1825 .pr_clear = sd_pr_clear,
1826};
1827
83d5cde4 1828static const struct block_device_operations sd_fops = {
1da177e4 1829 .owner = THIS_MODULE,
0338e291
AV
1830 .open = sd_open,
1831 .release = sd_release,
8a6cfeb6 1832 .ioctl = sd_ioctl,
a885c8c4 1833 .getgeo = sd_getgeo,
1da177e4 1834#ifdef CONFIG_COMPAT
0338e291 1835 .compat_ioctl = sd_compat_ioctl,
1da177e4 1836#endif
2bae0093 1837 .check_events = sd_check_events,
1da177e4 1838 .revalidate_disk = sd_revalidate_disk,
72ec24bd 1839 .unlock_native_capacity = sd_unlock_native_capacity,
e76239a3 1840 .report_zones = sd_zbc_report_zones,
924d55b0 1841 .pr_ops = &sd_pr_ops,
1da177e4
LT
1842};
1843
7a38dc0b
HR
1844/**
1845 * sd_eh_reset - reset error handling callback
1846 * @scmd: sd-issued command that has failed
1847 *
1848 * This function is called by the SCSI midlayer before starting
1849 * SCSI EH. When counting medium access failures we have to be
1850 * careful to register it only only once per device and SCSI EH run;
1851 * there might be several timed out commands which will cause the
1852 * 'max_medium_access_timeouts' counter to trigger after the first
1853 * SCSI EH run already and set the device to offline.
1854 * So this function resets the internal counter before starting SCSI EH.
1855 **/
1856static void sd_eh_reset(struct scsi_cmnd *scmd)
1857{
1858 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1859
1860 /* New SCSI EH run, reset gate variable */
1861 sdkp->ignore_medium_access_errors = false;
1862}
1863
18a4d0a2
MP
1864/**
1865 * sd_eh_action - error handling callback
1866 * @scmd: sd-issued command that has failed
18a4d0a2
MP
1867 * @eh_disp: The recovery disposition suggested by the midlayer
1868 *
2451079b
JB
1869 * This function is called by the SCSI midlayer upon completion of an
1870 * error test command (currently TEST UNIT READY). The result of sending
1871 * the eh command is passed in eh_disp. We're looking for devices that
1872 * fail medium access commands but are OK with non access commands like
1873 * test unit ready (so wrongly see the device as having a successful
1874 * recovery)
18a4d0a2 1875 **/
2451079b 1876static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
18a4d0a2
MP
1877{
1878 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
0db6ca8a 1879 struct scsi_device *sdev = scmd->device;
18a4d0a2 1880
0db6ca8a 1881 if (!scsi_device_online(sdev) ||
2451079b
JB
1882 !scsi_medium_access_command(scmd) ||
1883 host_byte(scmd->result) != DID_TIME_OUT ||
1884 eh_disp != SUCCESS)
18a4d0a2
MP
1885 return eh_disp;
1886
1887 /*
1888 * The device has timed out executing a medium access command.
1889 * However, the TEST UNIT READY command sent during error
1890 * handling completed successfully. Either the device is in the
1891 * process of recovering or has it suffered an internal failure
1892 * that prevents access to the storage medium.
1893 */
7a38dc0b
HR
1894 if (!sdkp->ignore_medium_access_errors) {
1895 sdkp->medium_access_timed_out++;
1896 sdkp->ignore_medium_access_errors = true;
1897 }
18a4d0a2
MP
1898
1899 /*
1900 * If the device keeps failing read/write commands but TEST UNIT
1901 * READY always completes successfully we assume that medium
1902 * access is no longer possible and take the device offline.
1903 */
1904 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1905 scmd_printk(KERN_ERR, scmd,
1906 "Medium access timeout failure. Offlining disk!\n");
0db6ca8a
BVA
1907 mutex_lock(&sdev->state_mutex);
1908 scsi_device_set_state(sdev, SDEV_OFFLINE);
1909 mutex_unlock(&sdev->state_mutex);
18a4d0a2 1910
e8f8d50e 1911 return SUCCESS;
18a4d0a2
MP
1912 }
1913
1914 return eh_disp;
1915}
1916
af55ff67
MP
1917static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1918{
6eadc612
DLM
1919 struct request *req = scmd->request;
1920 struct scsi_device *sdev = scmd->device;
1921 unsigned int transferred, good_bytes;
1922 u64 start_lba, end_lba, bad_lba;
1923
a8733c7b 1924 /*
6eadc612
DLM
1925 * Some commands have a payload smaller than the device logical
1926 * block size (e.g. INQUIRY on a 4K disk).
a8733c7b 1927 */
6eadc612 1928 if (scsi_bufflen(scmd) <= sdev->sector_size)
af55ff67
MP
1929 return 0;
1930
6eadc612
DLM
1931 /* Check if we have a 'bad_lba' information */
1932 if (!scsi_get_sense_info_fld(scmd->sense_buffer,
1933 SCSI_SENSE_BUFFERSIZE,
1934 &bad_lba))
af55ff67
MP
1935 return 0;
1936
6eadc612
DLM
1937 /*
1938 * If the bad lba was reported incorrectly, we have no idea where
af55ff67
MP
1939 * the error is.
1940 */
6eadc612
DLM
1941 start_lba = sectors_to_logical(sdev, blk_rq_pos(req));
1942 end_lba = start_lba + bytes_to_logical(sdev, scsi_bufflen(scmd));
1943 if (bad_lba < start_lba || bad_lba >= end_lba)
af55ff67
MP
1944 return 0;
1945
6eadc612
DLM
1946 /*
1947 * resid is optional but mostly filled in. When it's unused,
1948 * its value is zero, so we assume the whole buffer transferred
af55ff67 1949 */
6eadc612
DLM
1950 transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
1951
1952 /* This computation should always be done in terms of the
1953 * resolution of the device's medium.
af55ff67 1954 */
6eadc612
DLM
1955 good_bytes = logical_to_bytes(sdev, bad_lba - start_lba);
1956
a8733c7b 1957 return min(good_bytes, transferred);
af55ff67
MP
1958}
1959
1da177e4 1960/**
7b3d9545 1961 * sd_done - bottom half handler: called when the lower level
1da177e4
LT
1962 * driver has completed (successfully or otherwise) a scsi command.
1963 * @SCpnt: mid-level's per command structure.
1964 *
1965 * Note: potentially run from within an ISR. Must not block.
1966 **/
7b3d9545 1967static int sd_done(struct scsi_cmnd *SCpnt)
1da177e4
LT
1968{
1969 int result = SCpnt->result;
af55ff67 1970 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
c46f0917
DLM
1971 unsigned int sector_size = SCpnt->device->sector_size;
1972 unsigned int resid;
1da177e4 1973 struct scsi_sense_hdr sshdr;
4e7392ec 1974 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
26e85fcd 1975 struct request *req = SCpnt->request;
1da177e4
LT
1976 int sense_valid = 0;
1977 int sense_deferred = 0;
1da177e4 1978
89d94756
HR
1979 switch (req_op(req)) {
1980 case REQ_OP_DISCARD:
02d26103 1981 case REQ_OP_WRITE_ZEROES:
89d94756
HR
1982 case REQ_OP_WRITE_SAME:
1983 case REQ_OP_ZONE_RESET:
26e85fcd
MP
1984 if (!result) {
1985 good_bytes = blk_rq_bytes(req);
1986 scsi_set_resid(SCpnt, 0);
1987 } else {
1988 good_bytes = 0;
1989 scsi_set_resid(SCpnt, blk_rq_bytes(req));
89d94756
HR
1990 }
1991 break;
c46f0917
DLM
1992 default:
1993 /*
1994 * In case of bogus fw or device, we could end up having
1995 * an unaligned partial completion. Check this here and force
1996 * alignment.
1997 */
1998 resid = scsi_get_resid(SCpnt);
1999 if (resid & (sector_size - 1)) {
2000 sd_printk(KERN_INFO, sdkp,
2001 "Unaligned partial completion (resid=%u, sector_sz=%u)\n",
2002 resid, sector_size);
2003 resid = min(scsi_bufflen(SCpnt),
2004 round_up(resid, sector_size));
2005 scsi_set_resid(SCpnt, resid);
2006 }
26e85fcd 2007 }
6a32a8ae 2008
1da177e4
LT
2009 if (result) {
2010 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
2011 if (sense_valid)
2012 sense_deferred = scsi_sense_is_deferred(&sshdr);
2013 }
2a863ba8
DJ
2014 sdkp->medium_access_timed_out = 0;
2015
03aba2f7
LT
2016 if (driver_byte(result) != DRIVER_SENSE &&
2017 (!sense_valid || sense_deferred))
2018 goto out;
2019
2020 switch (sshdr.sense_key) {
2021 case HARDWARE_ERROR:
2022 case MEDIUM_ERROR:
af55ff67 2023 good_bytes = sd_completed_bytes(SCpnt);
03aba2f7
LT
2024 break;
2025 case RECOVERED_ERROR:
af55ff67
MP
2026 good_bytes = scsi_bufflen(SCpnt);
2027 break;
10dab226
JW
2028 case NO_SENSE:
2029 /* This indicates a false check condition, so ignore it. An
2030 * unknown amount of data was transferred so treat it as an
2031 * error.
2032 */
10dab226
JW
2033 SCpnt->result = 0;
2034 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2035 break;
c98a0eb0
MP
2036 case ABORTED_COMMAND:
2037 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
2038 good_bytes = sd_completed_bytes(SCpnt);
2039 break;
2040 case ILLEGAL_REQUEST:
d227ec26
CH
2041 switch (sshdr.asc) {
2042 case 0x10: /* DIX: Host detected corruption */
af55ff67 2043 good_bytes = sd_completed_bytes(SCpnt);
d227ec26
CH
2044 break;
2045 case 0x20: /* INVALID COMMAND OPCODE */
2046 case 0x24: /* INVALID FIELD IN CDB */
2047 switch (SCpnt->cmnd[0]) {
5db44863
MP
2048 case UNMAP:
2049 sd_config_discard(sdkp, SD_LBP_DISABLE);
2050 break;
2051 case WRITE_SAME_16:
2052 case WRITE_SAME:
d227ec26 2053 if (SCpnt->cmnd[1] & 8) { /* UNMAP */
5db44863 2054 sd_config_discard(sdkp, SD_LBP_DISABLE);
d227ec26 2055 } else {
5db44863
MP
2056 sdkp->device->no_write_same = 1;
2057 sd_config_write_same(sdkp);
e8064021 2058 req->rq_flags |= RQF_QUIET;
5db44863 2059 }
d227ec26 2060 break;
5db44863
MP
2061 }
2062 }
03aba2f7
LT
2063 break;
2064 default:
2065 break;
1da177e4 2066 }
89d94756 2067
03aba2f7 2068 out:
89d94756
HR
2069 if (sd_is_zoned(sdkp))
2070 sd_zbc_complete(SCpnt, good_bytes, &sshdr);
2071
ef61329d
HR
2072 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
2073 "sd_done: completed %d of %d bytes\n",
2074 good_bytes, scsi_bufflen(SCpnt)));
2075
10c41ddd
MG
2076 if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt) &&
2077 good_bytes)
2078 t10_pi_complete(SCpnt->request, sdkp->protection_type,
2079 good_bytes / scsi_prot_interval(SCpnt));
af55ff67 2080
7b3d9545 2081 return good_bytes;
1da177e4
LT
2082}
2083
1da177e4
LT
2084/*
2085 * spinup disk - called only in sd_revalidate_disk()
2086 */
2087static void
e73aec82 2088sd_spinup_disk(struct scsi_disk *sdkp)
ea73a9f2 2089{
1da177e4 2090 unsigned char cmd[10];
4451e472 2091 unsigned long spintime_expire = 0;
1da177e4
LT
2092 int retries, spintime;
2093 unsigned int the_result;
2094 struct scsi_sense_hdr sshdr;
2095 int sense_valid = 0;
2096
2097 spintime = 0;
2098
2099 /* Spin up drives, as required. Only do this at boot time */
2100 /* Spinup needs to be done for module loads too. */
2101 do {
2102 retries = 0;
2103
2104 do {
2105 cmd[0] = TEST_UNIT_READY;
2106 memset((void *) &cmd[1], 0, 9);
2107
ea73a9f2
JB
2108 the_result = scsi_execute_req(sdkp->device, cmd,
2109 DMA_NONE, NULL, 0,
2110 &sshdr, SD_TIMEOUT,
f4f4e47e 2111 SD_MAX_RETRIES, NULL);
1da177e4 2112
b4d38e38
AS
2113 /*
2114 * If the drive has indicated to us that it
2115 * doesn't have any media in it, don't bother
2116 * with any more polling.
2117 */
2118 if (media_not_present(sdkp, &sshdr))
2119 return;
2120
1da177e4 2121 if (the_result)
ea73a9f2 2122 sense_valid = scsi_sense_valid(&sshdr);
1da177e4
LT
2123 retries++;
2124 } while (retries < 3 &&
2125 (!scsi_status_is_good(the_result) ||
c65be1a6 2126 ((driver_byte(the_result) == DRIVER_SENSE) &&
1da177e4
LT
2127 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
2128
c65be1a6 2129 if (driver_byte(the_result) != DRIVER_SENSE) {
1da177e4
LT
2130 /* no sense, TUR either succeeded or failed
2131 * with a status error */
e73aec82 2132 if(!spintime && !scsi_status_is_good(the_result)) {
ef61329d
HR
2133 sd_print_result(sdkp, "Test Unit Ready failed",
2134 the_result);
e73aec82 2135 }
1da177e4
LT
2136 break;
2137 }
ef61329d 2138
1da177e4
LT
2139 /*
2140 * The device does not want the automatic start to be issued.
2141 */
33dd6f92 2142 if (sdkp->device->no_start_on_add)
1da177e4 2143 break;
1da177e4 2144
33dd6f92
MW
2145 if (sense_valid && sshdr.sense_key == NOT_READY) {
2146 if (sshdr.asc == 4 && sshdr.ascq == 3)
2147 break; /* manual intervention required */
2148 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
2149 break; /* standby */
2150 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
2151 break; /* unavailable */
505aa4b6
MR
2152 if (sshdr.asc == 4 && sshdr.ascq == 0x1b)
2153 break; /* sanitize in progress */
33dd6f92
MW
2154 /*
2155 * Issue command to spin up drive when not ready
2156 */
1da177e4 2157 if (!spintime) {
e73aec82 2158 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1da177e4
LT
2159 cmd[0] = START_STOP;
2160 cmd[1] = 1; /* Return immediately */
2161 memset((void *) &cmd[2], 0, 8);
2162 cmd[4] = 1; /* Start spin cycle */
d2886ea3
SR
2163 if (sdkp->device->start_stop_pwr_cond)
2164 cmd[4] |= 1 << 4;
ea73a9f2
JB
2165 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
2166 NULL, 0, &sshdr,
f4f4e47e
FT
2167 SD_TIMEOUT, SD_MAX_RETRIES,
2168 NULL);
4451e472
AS
2169 spintime_expire = jiffies + 100 * HZ;
2170 spintime = 1;
1da177e4 2171 }
1da177e4
LT
2172 /* Wait 1 second for next try */
2173 msleep(1000);
3a1d0783 2174 printk(KERN_CONT ".");
4451e472
AS
2175
2176 /*
2177 * Wait for USB flash devices with slow firmware.
2178 * Yes, this sense key/ASC combination shouldn't
2179 * occur here. It's characteristic of these devices.
2180 */
2181 } else if (sense_valid &&
2182 sshdr.sense_key == UNIT_ATTENTION &&
2183 sshdr.asc == 0x28) {
2184 if (!spintime) {
2185 spintime_expire = jiffies + 5 * HZ;
2186 spintime = 1;
2187 }
2188 /* Wait 1 second for next try */
2189 msleep(1000);
1da177e4
LT
2190 } else {
2191 /* we don't understand the sense code, so it's
2192 * probably pointless to loop */
2193 if(!spintime) {
e73aec82
MP
2194 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
2195 sd_print_sense_hdr(sdkp, &sshdr);
1da177e4
LT
2196 }
2197 break;
2198 }
2199
4451e472 2200 } while (spintime && time_before_eq(jiffies, spintime_expire));
1da177e4
LT
2201
2202 if (spintime) {
2203 if (scsi_status_is_good(the_result))
3a1d0783 2204 printk(KERN_CONT "ready\n");
1da177e4 2205 else
3a1d0783 2206 printk(KERN_CONT "not responding...\n");
1da177e4
LT
2207 }
2208}
2209
e0597d70
MP
2210/*
2211 * Determine whether disk supports Data Integrity Field.
2212 */
fe542396 2213static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
e0597d70
MP
2214{
2215 struct scsi_device *sdp = sdkp->device;
2216 u8 type;
fe542396 2217 int ret = 0;
e0597d70
MP
2218
2219 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
fe542396 2220 return ret;
35e1a5d9
MP
2221
2222 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
2223
8475c811 2224 if (type > T10_PI_TYPE3_PROTECTION)
fe542396
MP
2225 ret = -ENODEV;
2226 else if (scsi_host_dif_capable(sdp->host, type))
2227 ret = 1;
2228
2229 if (sdkp->first_scan || type != sdkp->protection_type)
2230 switch (ret) {
2231 case -ENODEV:
2232 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
2233 " protection type %u. Disabling disk!\n",
2234 type);
2235 break;
2236 case 1:
2237 sd_printk(KERN_NOTICE, sdkp,
2238 "Enabling DIF Type %u protection\n", type);
2239 break;
2240 case 0:
2241 sd_printk(KERN_NOTICE, sdkp,
2242 "Disabling DIF Type %u protection\n", type);
2243 break;
2244 }
e0597d70 2245
be922f47
MP
2246 sdkp->protection_type = type;
2247
fe542396 2248 return ret;
e0597d70
MP
2249}
2250
0da205e0
MW
2251static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
2252 struct scsi_sense_hdr *sshdr, int sense_valid,
2253 int the_result)
2254{
c65be1a6 2255 if (driver_byte(the_result) == DRIVER_SENSE)
0da205e0
MW
2256 sd_print_sense_hdr(sdkp, sshdr);
2257 else
2258 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
2259
2260 /*
2261 * Set dirty bit for removable devices if not ready -
2262 * sometimes drives will not report this properly.
2263 */
2264 if (sdp->removable &&
2265 sense_valid && sshdr->sense_key == NOT_READY)
2bae0093 2266 set_media_not_present(sdkp);
0da205e0
MW
2267
2268 /*
2269 * We used to set media_present to 0 here to indicate no media
2270 * in the drive, but some drives fail read capacity even with
2271 * media present, so we can't do that.
2272 */
2273 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
2274}
2275
2276#define RC16_LEN 32
2277#if RC16_LEN > SD_BUF_SIZE
2278#error RC16_LEN must not be more than SD_BUF_SIZE
2279#endif
2280
3233ac19
JB
2281#define READ_CAPACITY_RETRIES_ON_RESET 10
2282
7c856152
MP
2283/*
2284 * Ensure that we don't overflow sector_t when CONFIG_LBDAF is not set
2285 * and the reported logical block size is bigger than 512 bytes. Note
2286 * that last_sector is a u64 and therefore logical_to_sectors() is not
2287 * applicable.
2288 */
2289static bool sd_addressable_capacity(u64 lba, unsigned int sector_size)
2290{
2291 u64 last_sector = (lba + 1ULL) << (ilog2(sector_size) - 9);
2292
2293 if (sizeof(sector_t) == 4 && last_sector > U32_MAX)
2294 return false;
2295
2296 return true;
2297}
2298
0da205e0
MW
2299static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
2300 unsigned char *buffer)
ea73a9f2 2301{
1da177e4 2302 unsigned char cmd[16];
1da177e4
LT
2303 struct scsi_sense_hdr sshdr;
2304 int sense_valid = 0;
0da205e0 2305 int the_result;
3233ac19 2306 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
ea09bcc9 2307 unsigned int alignment;
0da205e0
MW
2308 unsigned long long lba;
2309 unsigned sector_size;
1da177e4 2310
5ce524bd
HG
2311 if (sdp->no_read_capacity_16)
2312 return -EINVAL;
2313
1da177e4 2314 do {
0da205e0 2315 memset(cmd, 0, 16);
eb846d9f 2316 cmd[0] = SERVICE_ACTION_IN_16;
0da205e0
MW
2317 cmd[1] = SAI_READ_CAPACITY_16;
2318 cmd[13] = RC16_LEN;
2319 memset(buffer, 0, RC16_LEN);
2320
ea73a9f2 2321 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
0da205e0
MW
2322 buffer, RC16_LEN, &sshdr,
2323 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1da177e4 2324
ea73a9f2 2325 if (media_not_present(sdkp, &sshdr))
0da205e0 2326 return -ENODEV;
1da177e4 2327
2b301307 2328 if (the_result) {
ea73a9f2 2329 sense_valid = scsi_sense_valid(&sshdr);
2b301307
MW
2330 if (sense_valid &&
2331 sshdr.sense_key == ILLEGAL_REQUEST &&
2332 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
2333 sshdr.ascq == 0x00)
2334 /* Invalid Command Operation Code or
2335 * Invalid Field in CDB, just retry
2336 * silently with RC10 */
2337 return -EINVAL;
3233ac19
JB
2338 if (sense_valid &&
2339 sshdr.sense_key == UNIT_ATTENTION &&
2340 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2341 /* Device reset might occur several times,
2342 * give it one more chance */
2343 if (--reset_retries > 0)
2344 continue;
2b301307 2345 }
1da177e4
LT
2346 retries--;
2347
2348 } while (the_result && retries);
2349
0da205e0 2350 if (the_result) {
ef61329d 2351 sd_print_result(sdkp, "Read Capacity(16) failed", the_result);
0da205e0
MW
2352 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2353 return -EINVAL;
2354 }
e73aec82 2355
8f76d151
DH
2356 sector_size = get_unaligned_be32(&buffer[8]);
2357 lba = get_unaligned_be64(&buffer[0]);
0da205e0 2358
fe542396
MP
2359 if (sd_read_protection_type(sdkp, buffer) < 0) {
2360 sdkp->capacity = 0;
2361 return -ENODEV;
2362 }
0da205e0 2363
7c856152 2364 if (!sd_addressable_capacity(lba, sector_size)) {
0da205e0
MW
2365 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2366 "kernel compiled with support for large block "
2367 "devices.\n");
2368 sdkp->capacity = 0;
2369 return -EOVERFLOW;
2370 }
2371
ea09bcc9 2372 /* Logical blocks per physical block exponent */
526f7c79 2373 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
ea09bcc9 2374
89d94756
HR
2375 /* RC basis */
2376 sdkp->rc_basis = (buffer[12] >> 4) & 0x3;
2377
ea09bcc9
MP
2378 /* Lowest aligned logical block */
2379 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2380 blk_queue_alignment_offset(sdp->request_queue, alignment);
2381 if (alignment && sdkp->first_scan)
2382 sd_printk(KERN_NOTICE, sdkp,
2383 "physical block alignment offset: %u\n", alignment);
2384
c98a0eb0
MP
2385 if (buffer[14] & 0x80) { /* LBPME */
2386 sdkp->lbpme = 1;
e339c1a7 2387
c98a0eb0
MP
2388 if (buffer[14] & 0x40) /* LBPRZ */
2389 sdkp->lbprz = 1;
e339c1a7 2390
c98a0eb0 2391 sd_config_discard(sdkp, SD_LBP_WS16);
e339c1a7
MP
2392 }
2393
0da205e0
MW
2394 sdkp->capacity = lba + 1;
2395 return sector_size;
2396}
2397
2398static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2399 unsigned char *buffer)
2400{
2401 unsigned char cmd[16];
2402 struct scsi_sense_hdr sshdr;
2403 int sense_valid = 0;
2404 int the_result;
3233ac19 2405 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
0da205e0
MW
2406 sector_t lba;
2407 unsigned sector_size;
2408
2409 do {
2410 cmd[0] = READ_CAPACITY;
2411 memset(&cmd[1], 0, 9);
2412 memset(buffer, 0, 8);
2413
2414 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2415 buffer, 8, &sshdr,
2416 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2417
2418 if (media_not_present(sdkp, &sshdr))
2419 return -ENODEV;
2420
3233ac19 2421 if (the_result) {
0da205e0 2422 sense_valid = scsi_sense_valid(&sshdr);
3233ac19
JB
2423 if (sense_valid &&
2424 sshdr.sense_key == UNIT_ATTENTION &&
2425 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2426 /* Device reset might occur several times,
2427 * give it one more chance */
2428 if (--reset_retries > 0)
2429 continue;
2430 }
0da205e0
MW
2431 retries--;
2432
2433 } while (the_result && retries);
2434
2435 if (the_result) {
ef61329d 2436 sd_print_result(sdkp, "Read Capacity(10) failed", the_result);
0da205e0
MW
2437 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2438 return -EINVAL;
2439 }
2440
8f76d151
DH
2441 sector_size = get_unaligned_be32(&buffer[4]);
2442 lba = get_unaligned_be32(&buffer[0]);
0da205e0 2443
5ce524bd
HG
2444 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2445 /* Some buggy (usb cardreader) devices return an lba of
2446 0xffffffff when the want to report a size of 0 (with
2447 which they really mean no media is present) */
2448 sdkp->capacity = 0;
5cc10350 2449 sdkp->physical_block_size = sector_size;
5ce524bd
HG
2450 return sector_size;
2451 }
2452
7c856152 2453 if (!sd_addressable_capacity(lba, sector_size)) {
0da205e0
MW
2454 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2455 "kernel compiled with support for large block "
2456 "devices.\n");
2457 sdkp->capacity = 0;
2458 return -EOVERFLOW;
2459 }
2460
2461 sdkp->capacity = lba + 1;
526f7c79 2462 sdkp->physical_block_size = sector_size;
0da205e0
MW
2463 return sector_size;
2464}
2465
2b301307
MW
2466static int sd_try_rc16_first(struct scsi_device *sdp)
2467{
f87146bb
HR
2468 if (sdp->host->max_cmd_len < 16)
2469 return 0;
6a0bdffa
AS
2470 if (sdp->try_rc_10_first)
2471 return 0;
2b301307
MW
2472 if (sdp->scsi_level > SCSI_SPC_2)
2473 return 1;
2474 if (scsi_device_protection(sdp))
2475 return 1;
2476 return 0;
2477}
2478
0da205e0
MW
2479/*
2480 * read disk capacity
2481 */
2482static void
2483sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2484{
2485 int sector_size;
2486 struct scsi_device *sdp = sdkp->device;
2487
2b301307 2488 if (sd_try_rc16_first(sdp)) {
0da205e0
MW
2489 sector_size = read_capacity_16(sdkp, sdp, buffer);
2490 if (sector_size == -EOVERFLOW)
1da177e4 2491 goto got_data;
2b301307
MW
2492 if (sector_size == -ENODEV)
2493 return;
2494 if (sector_size < 0)
2495 sector_size = read_capacity_10(sdkp, sdp, buffer);
0da205e0
MW
2496 if (sector_size < 0)
2497 return;
1da177e4 2498 } else {
0da205e0
MW
2499 sector_size = read_capacity_10(sdkp, sdp, buffer);
2500 if (sector_size == -EOVERFLOW)
2501 goto got_data;
2502 if (sector_size < 0)
2503 return;
2504 if ((sizeof(sdkp->capacity) > 4) &&
2505 (sdkp->capacity > 0xffffffffULL)) {
2506 int old_sector_size = sector_size;
2507 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2508 "Trying to use READ CAPACITY(16).\n");
2509 sector_size = read_capacity_16(sdkp, sdp, buffer);
2510 if (sector_size < 0) {
2511 sd_printk(KERN_NOTICE, sdkp,
2512 "Using 0xffffffff as device size\n");
2513 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2514 sector_size = old_sector_size;
2515 goto got_data;
2516 }
597d7400
MP
2517 /* Remember that READ CAPACITY(16) succeeded */
2518 sdp->try_rc_10_first = 0;
0da205e0
MW
2519 }
2520 }
1da177e4 2521
5c211caa
AS
2522 /* Some devices are known to return the total number of blocks,
2523 * not the highest block number. Some devices have versions
2524 * which do this and others which do not. Some devices we might
2525 * suspect of doing this but we don't know for certain.
2526 *
2527 * If we know the reported capacity is wrong, decrement it. If
2528 * we can only guess, then assume the number of blocks is even
2529 * (usually true but not always) and err on the side of lowering
2530 * the capacity.
2531 */
2532 if (sdp->fix_capacity ||
2533 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2534 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2535 "from its reported value: %llu\n",
2536 (unsigned long long) sdkp->capacity);
1da177e4 2537 --sdkp->capacity;
61bf54b7
ON
2538 }
2539
1da177e4
LT
2540got_data:
2541 if (sector_size == 0) {
2542 sector_size = 512;
e73aec82
MP
2543 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2544 "assuming 512.\n");
1da177e4
LT
2545 }
2546
2547 if (sector_size != 512 &&
2548 sector_size != 1024 &&
2549 sector_size != 2048 &&
74856fbf 2550 sector_size != 4096) {
e73aec82
MP
2551 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2552 sector_size);
1da177e4
LT
2553 /*
2554 * The user might want to re-format the drive with
2555 * a supported sectorsize. Once this happens, it
2556 * would be relatively trivial to set the thing up.
2557 * For this reason, we leave the thing in the table.
2558 */
2559 sdkp->capacity = 0;
2560 /*
2561 * set a bogus sector size so the normal read/write
2562 * logic in the block layer will eventually refuse any
2563 * request on this device without tripping over power
2564 * of two sector size assumptions
2565 */
2566 sector_size = 512;
2567 }
e1defc4f 2568 blk_queue_logical_block_size(sdp->request_queue, sector_size);
89d94756
HR
2569 blk_queue_physical_block_size(sdp->request_queue,
2570 sdkp->physical_block_size);
2571 sdkp->device->sector_size = sector_size;
7404ad3b 2572
89d94756
HR
2573 if (sdkp->capacity > 0xffffffff)
2574 sdp->use_16_for_rw = 1;
1da177e4 2575
89d94756 2576}
1da177e4 2577
89d94756
HR
2578/*
2579 * Print disk capacity
2580 */
2581static void
2582sd_print_capacity(struct scsi_disk *sdkp,
2583 sector_t old_capacity)
2584{
2585 int sector_size = sdkp->device->sector_size;
2586 char cap_str_2[10], cap_str_10[10];
ea09bcc9 2587
89d94756
HR
2588 string_get_size(sdkp->capacity, sector_size,
2589 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
2590 string_get_size(sdkp->capacity, sector_size,
2591 STRING_UNITS_10, cap_str_10,
2592 sizeof(cap_str_10));
1da177e4 2593
89d94756
HR
2594 if (sdkp->first_scan || old_capacity != sdkp->capacity) {
2595 sd_printk(KERN_NOTICE, sdkp,
2596 "%llu %d-byte logical blocks: (%s/%s)\n",
2597 (unsigned long long)sdkp->capacity,
2598 sector_size, cap_str_10, cap_str_2);
53ad570b 2599
89d94756
HR
2600 if (sdkp->physical_block_size != sector_size)
2601 sd_printk(KERN_NOTICE, sdkp,
2602 "%u-byte physical blocks\n",
2603 sdkp->physical_block_size);
2604
2605 sd_zbc_print_zones(sdkp);
2606 }
1da177e4
LT
2607}
2608
2609/* called with buffer of length 512 */
2610static inline int
ea73a9f2
JB
2611sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
2612 unsigned char *buffer, int len, struct scsi_mode_data *data,
2613 struct scsi_sense_hdr *sshdr)
1da177e4 2614{
ea73a9f2 2615 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1cf72699 2616 SD_TIMEOUT, SD_MAX_RETRIES, data,
ea73a9f2 2617 sshdr);
1da177e4
LT
2618}
2619
2620/*
2621 * read write protect setting, if possible - called only in sd_revalidate_disk()
48970800 2622 * called with buffer of length SD_BUF_SIZE
1da177e4
LT
2623 */
2624static void
e73aec82 2625sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
ea73a9f2 2626{
1da177e4 2627 int res;
ea73a9f2 2628 struct scsi_device *sdp = sdkp->device;
1da177e4 2629 struct scsi_mode_data data;
20bd1d02 2630 int disk_ro = get_disk_ro(sdkp->disk);
70a9b873 2631 int old_wp = sdkp->write_prot;
1da177e4
LT
2632
2633 set_disk_ro(sdkp->disk, 0);
ea73a9f2 2634 if (sdp->skip_ms_page_3f) {
b2bff6ce 2635 sd_first_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
1da177e4
LT
2636 return;
2637 }
2638
ea73a9f2
JB
2639 if (sdp->use_192_bytes_for_3f) {
2640 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1da177e4
LT
2641 } else {
2642 /*
2643 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2644 * We have to start carefully: some devices hang if we ask
2645 * for more than is available.
2646 */
ea73a9f2 2647 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1da177e4
LT
2648
2649 /*
2650 * Second attempt: ask for page 0 When only page 0 is
2651 * implemented, a request for page 3F may return Sense Key
2652 * 5: Illegal Request, Sense Code 24: Invalid field in
2653 * CDB.
2654 */
2655 if (!scsi_status_is_good(res))
ea73a9f2 2656 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1da177e4
LT
2657
2658 /*
2659 * Third attempt: ask 255 bytes, as we did earlier.
2660 */
2661 if (!scsi_status_is_good(res))
ea73a9f2
JB
2662 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
2663 &data, NULL);
1da177e4
LT
2664 }
2665
2666 if (!scsi_status_is_good(res)) {
b2bff6ce 2667 sd_first_printk(KERN_WARNING, sdkp,
e73aec82 2668 "Test WP failed, assume Write Enabled\n");
1da177e4
LT
2669 } else {
2670 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
20bd1d02 2671 set_disk_ro(sdkp->disk, sdkp->write_prot || disk_ro);
70a9b873
MP
2672 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2673 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2674 sdkp->write_prot ? "on" : "off");
df441cc0 2675 sd_printk(KERN_DEBUG, sdkp, "Mode Sense: %4ph\n", buffer);
70a9b873 2676 }
1da177e4
LT
2677 }
2678}
2679
2680/*
2681 * sd_read_cache_type - called only from sd_revalidate_disk()
48970800 2682 * called with buffer of length SD_BUF_SIZE
1da177e4
LT
2683 */
2684static void
e73aec82 2685sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
631e8a13 2686{
1da177e4 2687 int len = 0, res;
ea73a9f2 2688 struct scsi_device *sdp = sdkp->device;
1da177e4 2689
631e8a13
AV
2690 int dbd;
2691 int modepage;
0bcaa111 2692 int first_len;
1da177e4
LT
2693 struct scsi_mode_data data;
2694 struct scsi_sense_hdr sshdr;
70a9b873
MP
2695 int old_wce = sdkp->WCE;
2696 int old_rcd = sdkp->RCD;
2697 int old_dpofua = sdkp->DPOFUA;
1da177e4 2698
39c60a09
JB
2699
2700 if (sdkp->cache_override)
2701 return;
2702
0bcaa111
LT
2703 first_len = 4;
2704 if (sdp->skip_ms_page_8) {
2705 if (sdp->type == TYPE_RBC)
2706 goto defaults;
2707 else {
2708 if (sdp->skip_ms_page_3f)
2709 goto defaults;
2710 modepage = 0x3F;
2711 if (sdp->use_192_bytes_for_3f)
2712 first_len = 192;
2713 dbd = 0;
2714 }
2715 } else if (sdp->type == TYPE_RBC) {
631e8a13
AV
2716 modepage = 6;
2717 dbd = 8;
2718 } else {
2719 modepage = 8;
2720 dbd = 0;
2721 }
2722
1da177e4 2723 /* cautiously ask */
0bcaa111
LT
2724 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2725 &data, &sshdr);
1da177e4
LT
2726
2727 if (!scsi_status_is_good(res))
2728 goto bad_sense;
2729
6d73c851
AV
2730 if (!data.header_length) {
2731 modepage = 6;
0bcaa111 2732 first_len = 0;
b2bff6ce
MP
2733 sd_first_printk(KERN_ERR, sdkp,
2734 "Missing header in MODE_SENSE response\n");
6d73c851
AV
2735 }
2736
1da177e4
LT
2737 /* that went OK, now ask for the proper length */
2738 len = data.length;
2739
2740 /*
2741 * We're only interested in the first three bytes, actually.
2742 * But the data cache page is defined for the first 20.
2743 */
2744 if (len < 3)
2745 goto bad_sense;
0bcaa111 2746 else if (len > SD_BUF_SIZE) {
b2bff6ce 2747 sd_first_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
0bcaa111
LT
2748 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2749 len = SD_BUF_SIZE;
2750 }
2751 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2752 len = 192;
1da177e4
LT
2753
2754 /* Get the data */
0bcaa111
LT
2755 if (len > first_len)
2756 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2757 &data, &sshdr);
1da177e4
LT
2758
2759 if (scsi_status_is_good(res)) {
631e8a13 2760 int offset = data.header_length + data.block_descriptor_length;
1da177e4 2761
0bcaa111
LT
2762 while (offset < len) {
2763 u8 page_code = buffer[offset] & 0x3F;
2764 u8 spf = buffer[offset] & 0x40;
2765
2766 if (page_code == 8 || page_code == 6) {
2767 /* We're interested only in the first 3 bytes.
2768 */
2769 if (len - offset <= 2) {
b2bff6ce
MP
2770 sd_first_printk(KERN_ERR, sdkp,
2771 "Incomplete mode parameter "
2772 "data\n");
0bcaa111
LT
2773 goto defaults;
2774 } else {
2775 modepage = page_code;
2776 goto Page_found;
2777 }
2778 } else {
2779 /* Go to the next page */
2780 if (spf && len - offset > 3)
2781 offset += 4 + (buffer[offset+2] << 8) +
2782 buffer[offset+3];
2783 else if (!spf && len - offset > 1)
2784 offset += 2 + buffer[offset+1];
2785 else {
b2bff6ce
MP
2786 sd_first_printk(KERN_ERR, sdkp,
2787 "Incomplete mode "
2788 "parameter data\n");
0bcaa111
LT
2789 goto defaults;
2790 }
2791 }
48970800
AV
2792 }
2793
b2bff6ce 2794 sd_first_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
984f1733
AS
2795 goto defaults;
2796
0bcaa111 2797 Page_found:
631e8a13
AV
2798 if (modepage == 8) {
2799 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2800 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2801 } else {
2802 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2803 sdkp->RCD = 0;
2804 }
1da177e4 2805
007365ad 2806 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
b14bf2d0
AS
2807 if (sdp->broken_fua) {
2808 sd_first_printk(KERN_NOTICE, sdkp, "Disabling FUA\n");
2809 sdkp->DPOFUA = 0;
26f28197
DLM
2810 } else if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw &&
2811 !sdkp->device->use_16_for_rw) {
b2bff6ce 2812 sd_first_printk(KERN_NOTICE, sdkp,
e73aec82 2813 "Uses READ/WRITE(6), disabling FUA\n");
007365ad
TH
2814 sdkp->DPOFUA = 0;
2815 }
2816
2eefd57b
SRT
2817 /* No cache flush allowed for write protected devices */
2818 if (sdkp->WCE && sdkp->write_prot)
2819 sdkp->WCE = 0;
2820
70a9b873
MP
2821 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2822 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2823 sd_printk(KERN_NOTICE, sdkp,
2824 "Write cache: %s, read cache: %s, %s\n",
2825 sdkp->WCE ? "enabled" : "disabled",
2826 sdkp->RCD ? "disabled" : "enabled",
2827 sdkp->DPOFUA ? "supports DPO and FUA"
2828 : "doesn't support DPO or FUA");
1da177e4
LT
2829
2830 return;
2831 }
2832
2833bad_sense:
ea73a9f2 2834 if (scsi_sense_valid(&sshdr) &&
1da177e4
LT
2835 sshdr.sense_key == ILLEGAL_REQUEST &&
2836 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
e73aec82 2837 /* Invalid field in CDB */
b2bff6ce 2838 sd_first_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
1da177e4 2839 else
b2bff6ce
MP
2840 sd_first_printk(KERN_ERR, sdkp,
2841 "Asking for cache data failed\n");
1da177e4
LT
2842
2843defaults:
b81478d8 2844 if (sdp->wce_default_on) {
b2bff6ce
MP
2845 sd_first_printk(KERN_NOTICE, sdkp,
2846 "Assuming drive cache: write back\n");
b81478d8
NJ
2847 sdkp->WCE = 1;
2848 } else {
b2bff6ce
MP
2849 sd_first_printk(KERN_ERR, sdkp,
2850 "Assuming drive cache: write through\n");
b81478d8
NJ
2851 sdkp->WCE = 0;
2852 }
1da177e4 2853 sdkp->RCD = 0;
48970800 2854 sdkp->DPOFUA = 0;
1da177e4
LT
2855}
2856
e0597d70
MP
2857/*
2858 * The ATO bit indicates whether the DIF application tag is available
2859 * for use by the operating system.
2860 */
439d77f7 2861static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
e0597d70
MP
2862{
2863 int res, offset;
2864 struct scsi_device *sdp = sdkp->device;
2865 struct scsi_mode_data data;
2866 struct scsi_sense_hdr sshdr;
2867
89d94756 2868 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
e0597d70
MP
2869 return;
2870
2871 if (sdkp->protection_type == 0)
2872 return;
2873
2874 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2875 SD_MAX_RETRIES, &data, &sshdr);
2876
2877 if (!scsi_status_is_good(res) || !data.header_length ||
2878 data.length < 6) {
b2bff6ce 2879 sd_first_printk(KERN_WARNING, sdkp,
e0597d70
MP
2880 "getting Control mode page failed, assume no ATO\n");
2881
2882 if (scsi_sense_valid(&sshdr))
2883 sd_print_sense_hdr(sdkp, &sshdr);
2884
2885 return;
2886 }
2887
2888 offset = data.header_length + data.block_descriptor_length;
2889
2890 if ((buffer[offset] & 0x3f) != 0x0a) {
b2bff6ce 2891 sd_first_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
e0597d70
MP
2892 return;
2893 }
2894
2895 if ((buffer[offset + 5] & 0x80) == 0)
2896 return;
2897
2898 sdkp->ATO = 1;
2899
2900 return;
2901}
2902
d11b6916
MP
2903/**
2904 * sd_read_block_limits - Query disk device for preferred I/O sizes.
7529fbb0 2905 * @sdkp: disk to query
d11b6916
MP
2906 */
2907static void sd_read_block_limits(struct scsi_disk *sdkp)
2908{
2909 unsigned int sector_sz = sdkp->device->sector_size;
bb2d3de1 2910 const int vpd_len = 64;
e3deec09 2911 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
d11b6916 2912
e3deec09
JB
2913 if (!buffer ||
2914 /* Block Limits VPD */
2915 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2916 goto out;
d11b6916
MP
2917
2918 blk_queue_io_min(sdkp->disk->queue,
2919 get_unaligned_be16(&buffer[6]) * sector_sz);
ca369d51
MP
2920
2921 sdkp->max_xfer_blocks = get_unaligned_be32(&buffer[8]);
2922 sdkp->opt_xfer_blocks = get_unaligned_be32(&buffer[12]);
d11b6916 2923
c98a0eb0
MP
2924 if (buffer[3] == 0x3c) {
2925 unsigned int lba_count, desc_count;
e339c1a7 2926
5db44863 2927 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
e339c1a7 2928
c98a0eb0 2929 if (!sdkp->lbpme)
045d3fe7 2930 goto out;
045d3fe7 2931
c98a0eb0
MP
2932 lba_count = get_unaligned_be32(&buffer[20]);
2933 desc_count = get_unaligned_be32(&buffer[24]);
045d3fe7 2934
c98a0eb0
MP
2935 if (lba_count && desc_count)
2936 sdkp->max_unmap_blocks = lba_count;
e339c1a7 2937
c98a0eb0 2938 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
e339c1a7
MP
2939
2940 if (buffer[32] & 0x80)
c98a0eb0 2941 sdkp->unmap_alignment =
e339c1a7 2942 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
c98a0eb0
MP
2943
2944 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2945
2946 if (sdkp->max_unmap_blocks)
2947 sd_config_discard(sdkp, SD_LBP_UNMAP);
2948 else
2949 sd_config_discard(sdkp, SD_LBP_WS16);
2950
2951 } else { /* LBP VPD page tells us what to use */
bcd069bb 2952 if (sdkp->lbpu && sdkp->max_unmap_blocks)
e461338b
MP
2953 sd_config_discard(sdkp, SD_LBP_UNMAP);
2954 else if (sdkp->lbpws)
c98a0eb0
MP
2955 sd_config_discard(sdkp, SD_LBP_WS16);
2956 else if (sdkp->lbpws10)
2957 sd_config_discard(sdkp, SD_LBP_WS10);
2958 else
2959 sd_config_discard(sdkp, SD_LBP_DISABLE);
2960 }
e339c1a7
MP
2961 }
2962
e3deec09 2963 out:
d11b6916
MP
2964 kfree(buffer);
2965}
2966
3821d768
MP
2967/**
2968 * sd_read_block_characteristics - Query block dev. characteristics
7529fbb0 2969 * @sdkp: disk to query
3821d768
MP
2970 */
2971static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2972{
89d94756 2973 struct request_queue *q = sdkp->disk->queue;
e3deec09 2974 unsigned char *buffer;
3821d768 2975 u16 rot;
bb2d3de1 2976 const int vpd_len = 64;
3821d768 2977
e3deec09 2978 buffer = kmalloc(vpd_len, GFP_KERNEL);
3821d768 2979
e3deec09
JB
2980 if (!buffer ||
2981 /* Block Device Characteristics VPD */
2982 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2983 goto out;
3821d768
MP
2984
2985 rot = get_unaligned_be16(&buffer[4]);
2986
b277da0a 2987 if (rot == 1) {
8b904b5b
BVA
2988 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
2989 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, q);
83e32a59
XZ
2990 } else {
2991 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
2992 blk_queue_flag_set(QUEUE_FLAG_ADD_RANDOM, q);
b277da0a 2993 }
3821d768 2994
68af412c
DLM
2995 if (sdkp->device->type == TYPE_ZBC) {
2996 /* Host-managed */
89d94756 2997 q->limits.zoned = BLK_ZONED_HM;
68af412c
DLM
2998 } else {
2999 sdkp->zoned = (buffer[8] >> 4) & 3;
3000 if (sdkp->zoned == 1)
3001 /* Host-aware */
3002 q->limits.zoned = BLK_ZONED_HA;
3003 else
3004 /*
3005 * Treat drive-managed devices as
3006 * regular block devices.
3007 */
3008 q->limits.zoned = BLK_ZONED_NONE;
3009 }
89d94756
HR
3010 if (blk_queue_is_zoned(q) && sdkp->first_scan)
3011 sd_printk(KERN_NOTICE, sdkp, "Host-%s zoned block device\n",
3012 q->limits.zoned == BLK_ZONED_HM ? "managed" : "aware");
3013
e3deec09 3014 out:
3821d768
MP
3015 kfree(buffer);
3016}
3017
045d3fe7 3018/**
c98a0eb0 3019 * sd_read_block_provisioning - Query provisioning VPD page
7529fbb0 3020 * @sdkp: disk to query
045d3fe7 3021 */
c98a0eb0 3022static void sd_read_block_provisioning(struct scsi_disk *sdkp)
045d3fe7
MP
3023{
3024 unsigned char *buffer;
3025 const int vpd_len = 8;
3026
c98a0eb0 3027 if (sdkp->lbpme == 0)
045d3fe7
MP
3028 return;
3029
3030 buffer = kmalloc(vpd_len, GFP_KERNEL);
3031
3032 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
3033 goto out;
3034
c98a0eb0
MP
3035 sdkp->lbpvpd = 1;
3036 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
3037 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
3038 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
045d3fe7
MP
3039
3040 out:
3041 kfree(buffer);
3042}
3043
5db44863
MP
3044static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
3045{
66c28f97
MP
3046 struct scsi_device *sdev = sdkp->device;
3047
54b2b50c
MP
3048 if (sdev->host->no_write_same) {
3049 sdev->no_write_same = 1;
3050
3051 return;
3052 }
3053
66c28f97 3054 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
af73623f
BS
3055 /* too large values might cause issues with arcmsr */
3056 int vpd_buf_len = 64;
3057
66c28f97
MP
3058 sdev->no_report_opcodes = 1;
3059
3060 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
3061 * CODES is unsupported and the device has an ATA
3062 * Information VPD page (SAT).
3063 */
af73623f 3064 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
66c28f97
MP
3065 sdev->no_write_same = 1;
3066 }
3067
3068 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
5db44863 3069 sdkp->ws16 = 1;
66c28f97
MP
3070
3071 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
3072 sdkp->ws10 = 1;
5db44863
MP
3073}
3074
d80210f2
CH
3075static void sd_read_security(struct scsi_disk *sdkp, unsigned char *buffer)
3076{
3077 struct scsi_device *sdev = sdkp->device;
3078
3079 if (!sdev->security_supported)
3080 return;
3081
3082 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3083 SECURITY_PROTOCOL_IN) == 1 &&
3084 scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3085 SECURITY_PROTOCOL_OUT) == 1)
3086 sdkp->security = 1;
3087}
3088
1da177e4
LT
3089/**
3090 * sd_revalidate_disk - called the first time a new disk is seen,
3091 * performs disk spin up, read_capacity, etc.
3092 * @disk: struct gendisk we care about
3093 **/
3094static int sd_revalidate_disk(struct gendisk *disk)
3095{
3096 struct scsi_disk *sdkp = scsi_disk(disk);
3097 struct scsi_device *sdp = sdkp->device;
ca369d51 3098 struct request_queue *q = sdkp->disk->queue;
89d94756 3099 sector_t old_capacity = sdkp->capacity;
1da177e4 3100 unsigned char *buffer;
ca369d51 3101 unsigned int dev_max, rw_max;
1da177e4 3102
fa0d34be
MP
3103 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
3104 "sd_revalidate_disk\n"));
1da177e4
LT
3105
3106 /*
3107 * If the device is offline, don't try and read capacity or any
3108 * of the other niceties.
3109 */
3110 if (!scsi_device_online(sdp))
3111 goto out;
3112
a6123f14 3113 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
1da177e4 3114 if (!buffer) {
e73aec82
MP
3115 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
3116 "allocation failure.\n");
ea73a9f2 3117 goto out;
1da177e4
LT
3118 }
3119
e73aec82 3120 sd_spinup_disk(sdkp);
1da177e4
LT
3121
3122 /*
3123 * Without media there is no reason to ask; moreover, some devices
3124 * react badly if we do.
3125 */
3126 if (sdkp->media_present) {
e73aec82 3127 sd_read_capacity(sdkp, buffer);
ffd4bc2a 3128
5ddfe085 3129 if (scsi_device_supports_vpd(sdp)) {
c98a0eb0 3130 sd_read_block_provisioning(sdkp);
ffd4bc2a
MP
3131 sd_read_block_limits(sdkp);
3132 sd_read_block_characteristics(sdkp);
89d94756 3133 sd_zbc_read_zones(sdkp, buffer);
ffd4bc2a
MP
3134 }
3135
89d94756
HR
3136 sd_print_capacity(sdkp, old_capacity);
3137
e73aec82
MP
3138 sd_read_write_protect_flag(sdkp, buffer);
3139 sd_read_cache_type(sdkp, buffer);
e0597d70 3140 sd_read_app_tag_own(sdkp, buffer);
5db44863 3141 sd_read_write_same(sdkp, buffer);
d80210f2 3142 sd_read_security(sdkp, buffer);
1da177e4 3143 }
461d4e90
TH
3144
3145 /*
3146 * We now have all cache related info, determine how we deal
4913efe4 3147 * with flush requests.
461d4e90 3148 */
cb2fb68d 3149 sd_set_flush_flag(sdkp);
461d4e90 3150
ca369d51
MP
3151 /* Initial block count limit based on CDB TRANSFER LENGTH field size. */
3152 dev_max = sdp->use_16_for_rw ? SD_MAX_XFER_BLOCKS : SD_DEF_XFER_BLOCKS;
3153
3154 /* Some devices report a maximum block count for READ/WRITE requests. */
3155 dev_max = min_not_zero(dev_max, sdkp->max_xfer_blocks);
3156 q->limits.max_dev_sectors = logical_to_sectors(sdp, dev_max);
3157
3158 /*
77082ca5 3159 * Determine the device's preferred I/O size for reads and writes
9c1d9c20
MP
3160 * unless the reported value is unreasonably small, large, or
3161 * garbage.
ca369d51 3162 */
9c1d9c20
MP
3163 if (sdkp->opt_xfer_blocks &&
3164 sdkp->opt_xfer_blocks <= dev_max &&
3165 sdkp->opt_xfer_blocks <= SD_DEF_XFER_BLOCKS &&
6b7e9cde
MP
3166 logical_to_bytes(sdp, sdkp->opt_xfer_blocks) >= PAGE_SIZE) {
3167 q->limits.io_opt = logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3168 rw_max = logical_to_sectors(sdp, sdkp->opt_xfer_blocks);
3169 } else
67804145
FZ
3170 rw_max = min_not_zero(logical_to_sectors(sdp, dev_max),
3171 (sector_t)BLK_DEF_MAX_SECTORS);
3a9794d3 3172
77082ca5
MP
3173 /* Do not exceed controller limit */
3174 rw_max = min(rw_max, queue_max_hw_sectors(q));
3175
3176 /*
3177 * Only update max_sectors if previously unset or if the current value
3178 * exceeds the capabilities of the hardware.
3179 */
3180 if (sdkp->first_scan ||
3181 q->limits.max_sectors > q->limits.max_dev_sectors ||
3182 q->limits.max_sectors > q->limits.max_hw_sectors)
3183 q->limits.max_sectors = rw_max;
3184
3185 sdkp->first_scan = 0;
4f258a46 3186
f08bb1e0 3187 set_capacity(disk, logical_to_sectors(sdp, sdkp->capacity));
5db44863 3188 sd_config_write_same(sdkp);
1da177e4
LT
3189 kfree(buffer);
3190
1da177e4
LT
3191 out:
3192 return 0;
3193}
3194
72ec24bd
TH
3195/**
3196 * sd_unlock_native_capacity - unlock native capacity
3197 * @disk: struct gendisk to set capacity for
3198 *
3199 * Block layer calls this function if it detects that partitions
3200 * on @disk reach beyond the end of the device. If the SCSI host
3201 * implements ->unlock_native_capacity() method, it's invoked to
3202 * give it a chance to adjust the device capacity.
3203 *
3204 * CONTEXT:
3205 * Defined by block layer. Might sleep.
3206 */
3207static void sd_unlock_native_capacity(struct gendisk *disk)
3208{
3209 struct scsi_device *sdev = scsi_disk(disk)->device;
3210
3211 if (sdev->host->hostt->unlock_native_capacity)
3212 sdev->host->hostt->unlock_native_capacity(sdev);
3213}
3214
3e1a7ff8
TH
3215/**
3216 * sd_format_disk_name - format disk name
3217 * @prefix: name prefix - ie. "sd" for SCSI disks
3218 * @index: index of the disk to format name for
3219 * @buf: output buffer
3220 * @buflen: length of the output buffer
3221 *
3222 * SCSI disk names starts at sda. The 26th device is sdz and the
3223 * 27th is sdaa. The last one for two lettered suffix is sdzz
3224 * which is followed by sdaaa.
3225 *
3226 * This is basically 26 base counting with one extra 'nil' entry
3ad2f3fb 3227 * at the beginning from the second digit on and can be
3e1a7ff8
TH
3228 * determined using similar method as 26 base conversion with the
3229 * index shifted -1 after each digit is computed.
3230 *
3231 * CONTEXT:
3232 * Don't care.
3233 *
3234 * RETURNS:
3235 * 0 on success, -errno on failure.
3236 */
3237static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
3238{
3239 const int base = 'z' - 'a' + 1;
3240 char *begin = buf + strlen(prefix);
3241 char *end = buf + buflen;
3242 char *p;
3243 int unit;
3244
3245 p = end - 1;
3246 *p = '\0';
3247 unit = base;
3248 do {
3249 if (p == begin)
3250 return -EINVAL;
3251 *--p = 'a' + (index % unit);
3252 index = (index / unit) - 1;
3253 } while (index >= 0);
3254
3255 memmove(begin, p, end - p);
3256 memcpy(buf, prefix, strlen(prefix));
3257
3258 return 0;
3259}
3260
4ace92fc
AV
3261/*
3262 * The asynchronous part of sd_probe
3263 */
3264static void sd_probe_async(void *data, async_cookie_t cookie)
3265{
3266 struct scsi_disk *sdkp = data;
3267 struct scsi_device *sdp;
3268 struct gendisk *gd;
3269 u32 index;
3270 struct device *dev;
3271
3272 sdp = sdkp->device;
3273 gd = sdkp->disk;
3274 index = sdkp->index;
3275 dev = &sdp->sdev_gendev;
3276
1a03ae0f
MR
3277 gd->major = sd_major((index & 0xf0) >> 4);
3278 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
1a03ae0f 3279
4ace92fc
AV
3280 gd->fops = &sd_fops;
3281 gd->private_data = &sdkp->driver;
3282 gd->queue = sdkp->device->request_queue;
3283
70a9b873
MP
3284 /* defaults, until the device tells us otherwise */
3285 sdp->sector_size = 512;
3286 sdkp->capacity = 0;
3287 sdkp->media_present = 1;
3288 sdkp->write_prot = 0;
39c60a09 3289 sdkp->cache_override = 0;
70a9b873
MP
3290 sdkp->WCE = 0;
3291 sdkp->RCD = 0;
3292 sdkp->ATO = 0;
3293 sdkp->first_scan = 1;
18a4d0a2 3294 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
70a9b873 3295
4ace92fc
AV
3296 sd_revalidate_disk(gd);
3297
97fedbbe 3298 gd->flags = GENHD_FL_EXT_DEVT;
2bae0093 3299 if (sdp->removable) {
4ace92fc 3300 gd->flags |= GENHD_FL_REMOVABLE;
2bae0093
TH
3301 gd->events |= DISK_EVENT_MEDIA_CHANGE;
3302 }
4ace92fc 3303
10c580e4 3304 blk_pm_runtime_init(sdp->request_queue, dev);
fef912bf 3305 device_add_disk(dev, gd, NULL);
fe542396
MP
3306 if (sdkp->capacity)
3307 sd_dif_config_host(sdkp);
4ace92fc 3308
3821d768
MP
3309 sd_revalidate_disk(gd);
3310
d80210f2
CH
3311 if (sdkp->security) {
3312 sdkp->opal_dev = init_opal_dev(sdp, &sd_sec_submit);
3313 if (sdkp->opal_dev)
3314 sd_printk(KERN_NOTICE, sdkp, "supports TCG Opal\n");
3315 }
3316
4ace92fc
AV
3317 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
3318 sdp->removable ? "removable " : "");
478a8a05 3319 scsi_autopm_put_device(sdp);
ea038f63 3320 put_device(&sdkp->dev);
4ace92fc
AV
3321}
3322
1da177e4
LT
3323/**
3324 * sd_probe - called during driver initialization and whenever a
3325 * new scsi device is attached to the system. It is called once
3326 * for each scsi device (not just disks) present.
3327 * @dev: pointer to device object
3328 *
3329 * Returns 0 if successful (or not interested in this scsi device
3330 * (e.g. scanner)); 1 when there is an error.
3331 *
3332 * Note: this function is invoked from the scsi mid-level.
3333 * This function sets up the mapping between a given
3334 * <host,channel,id,lun> (found in sdp) and new device name
3335 * (e.g. /dev/sda). More precisely it is the block device major
3336 * and minor number that is chosen here.
3337 *
2db93ce8
PU
3338 * Assume sd_probe is not re-entrant (for time being)
3339 * Also think about sd_probe() and sd_remove() running coincidentally.
1da177e4
LT
3340 **/
3341static int sd_probe(struct device *dev)
3342{
3343 struct scsi_device *sdp = to_scsi_device(dev);
3344 struct scsi_disk *sdkp;
3345 struct gendisk *gd;
439d77f7 3346 int index;
1da177e4
LT
3347 int error;
3348
6fe8c1db 3349 scsi_autopm_get_device(sdp);
1da177e4 3350 error = -ENODEV;
89d94756
HR
3351 if (sdp->type != TYPE_DISK &&
3352 sdp->type != TYPE_ZBC &&
3353 sdp->type != TYPE_MOD &&
3354 sdp->type != TYPE_RBC)
1da177e4
LT
3355 goto out;
3356
89d94756
HR
3357#ifndef CONFIG_BLK_DEV_ZONED
3358 if (sdp->type == TYPE_ZBC)
3359 goto out;
3360#endif
9ccfc756 3361 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
2db93ce8 3362 "sd_probe\n"));
1da177e4
LT
3363
3364 error = -ENOMEM;
24669f75 3365 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
1da177e4
LT
3366 if (!sdkp)
3367 goto out;
3368
689d6fac 3369 gd = alloc_disk(SD_MINORS);
1da177e4 3370 if (!gd)
c01228db 3371 goto out_free;
1da177e4 3372
94015080
MW
3373 index = ida_alloc(&sd_index_ida, GFP_KERNEL);
3374 if (index < 0) {
21208ae5 3375 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
1da177e4 3376 goto out_put;
1a03ae0f
MR
3377 }
3378
3e1a7ff8 3379 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
21208ae5
DK
3380 if (error) {
3381 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
f27bac27 3382 goto out_free_index;
21208ae5 3383 }
f27bac27 3384
1da177e4
LT
3385 sdkp->device = sdp;
3386 sdkp->driver = &sd_template;
3387 sdkp->disk = gd;
3388 sdkp->index = index;
409f3499 3389 atomic_set(&sdkp->openers, 0);
9e1a1537 3390 atomic_set(&sdkp->device->ioerr_cnt, 0);
1da177e4 3391
601e7638
JB
3392 if (!sdp->request_queue->rq_timeout) {
3393 if (sdp->type != TYPE_MOD)
3394 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
3395 else
3396 blk_queue_rq_timeout(sdp->request_queue,
3397 SD_MOD_TIMEOUT);
3398 }
3399
3400 device_initialize(&sdkp->dev);
478a8a05 3401 sdkp->dev.parent = dev;
601e7638 3402 sdkp->dev.class = &sd_disk_class;
02aa2a37 3403 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
601e7638 3404
dee0586e
DC
3405 error = device_add(&sdkp->dev);
3406 if (error)
601e7638
JB
3407 goto out_free_index;
3408
478a8a05
AS
3409 get_device(dev);
3410 dev_set_drvdata(dev, sdkp);
601e7638 3411
ea038f63 3412 get_device(&sdkp->dev); /* prevent release before async_schedule */
a7a20d10 3413 async_schedule_domain(sd_probe_async, sdkp, &scsi_sd_probe_domain);
1da177e4
LT
3414
3415 return 0;
3416
f27bac27 3417 out_free_index:
94015080 3418 ida_free(&sd_index_ida, index);
6bdaa1f1 3419 out_put:
1da177e4 3420 put_disk(gd);
f170396c
CIK
3421 out_free:
3422 kfree(sdkp);
6bdaa1f1 3423 out:
6fe8c1db 3424 scsi_autopm_put_device(sdp);
1da177e4
LT
3425 return error;
3426}
3427
3428/**
3429 * sd_remove - called whenever a scsi disk (previously recognized by
3430 * sd_probe) is detached from the system. It is called (potentially
3431 * multiple times) during sd module unload.
f2a3313d 3432 * @dev: pointer to device object
1da177e4
LT
3433 *
3434 * Note: this function is invoked from the scsi mid-level.
3435 * This function potentially frees up a device name (e.g. /dev/sdc)
3436 * that could be re-used by a subsequent sd_probe().
3437 * This function is not called when the built-in sd driver is "exit-ed".
3438 **/
3439static int sd_remove(struct device *dev)
3440{
601e7638 3441 struct scsi_disk *sdkp;
0761df9c 3442 dev_t devt;
1da177e4 3443
601e7638 3444 sdkp = dev_get_drvdata(dev);
0761df9c 3445 devt = disk_devt(sdkp->disk);
478a8a05
AS
3446 scsi_autopm_get_device(sdkp->device);
3447
3c31b52f 3448 async_synchronize_full_domain(&scsi_sd_pm_domain);
a7a20d10 3449 async_synchronize_full_domain(&scsi_sd_probe_domain);
ee959b00 3450 device_del(&sdkp->dev);
1da177e4
LT
3451 del_gendisk(sdkp->disk);
3452 sd_shutdown(dev);
39b7f1e2 3453
d80210f2
CH
3454 free_opal_dev(sdkp->opal_dev);
3455
0761df9c
HR
3456 blk_register_region(devt, SD_MINORS, NULL,
3457 sd_default_probe, NULL, NULL);
3458
0b950672 3459 mutex_lock(&sd_ref_mutex);
39b7f1e2 3460 dev_set_drvdata(dev, NULL);
ee959b00 3461 put_device(&sdkp->dev);
0b950672 3462 mutex_unlock(&sd_ref_mutex);
1da177e4
LT
3463
3464 return 0;
3465}
3466
3467/**
3468 * scsi_disk_release - Called to free the scsi_disk structure
ee959b00 3469 * @dev: pointer to embedded class device
1da177e4 3470 *
0b950672 3471 * sd_ref_mutex must be held entering this routine. Because it is
1da177e4
LT
3472 * called on last put, you should always use the scsi_disk_get()
3473 * scsi_disk_put() helpers which manipulate the semaphore directly
ee959b00 3474 * and never do a direct put_device.
1da177e4 3475 **/
ee959b00 3476static void scsi_disk_release(struct device *dev)
1da177e4 3477{
ee959b00 3478 struct scsi_disk *sdkp = to_scsi_disk(dev);
1da177e4
LT
3479 struct gendisk *disk = sdkp->disk;
3480
94015080 3481 ida_free(&sd_index_ida, sdkp->index);
c01228db 3482
1da177e4 3483 disk->private_data = NULL;
1da177e4 3484 put_disk(disk);
39b7f1e2 3485 put_device(&sdkp->device->sdev_gendev);
1da177e4
LT
3486
3487 kfree(sdkp);
3488}
3489
cc5d2c8c 3490static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
c3c94c5a
TH
3491{
3492 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3493 struct scsi_sense_hdr sshdr;
cc5d2c8c 3494 struct scsi_device *sdp = sdkp->device;
c3c94c5a
TH
3495 int res;
3496
3497 if (start)
3498 cmd[4] |= 1; /* START */
3499
d2886ea3
SR
3500 if (sdp->start_stop_pwr_cond)
3501 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3502
c3c94c5a
TH
3503 if (!scsi_device_online(sdp))
3504 return -ENODEV;
3505
fcbfffe2
CH
3506 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, &sshdr,
3507 SD_TIMEOUT, SD_MAX_RETRIES, 0, RQF_PM, NULL);
c3c94c5a 3508 if (res) {
ef61329d 3509 sd_print_result(sdkp, "Start/Stop Unit failed", res);
c65be1a6 3510 if (driver_byte(res) == DRIVER_SENSE)
cc5d2c8c 3511 sd_print_sense_hdr(sdkp, &sshdr);
95897910
ON
3512 if (scsi_sense_valid(&sshdr) &&
3513 /* 0x3a is medium not present */
3514 sshdr.asc == 0x3a)
3515 res = 0;
c3c94c5a
TH
3516 }
3517
95897910
ON
3518 /* SCSI error codes must not go to the generic layer */
3519 if (res)
3520 return -EIO;
3521
3522 return 0;
c3c94c5a
TH
3523}
3524
1da177e4
LT
3525/*
3526 * Send a SYNCHRONIZE CACHE instruction down to the device through
3527 * the normal SCSI command structure. Wait for the command to
3528 * complete.
3529 */
3530static void sd_shutdown(struct device *dev)
3531{
3d9a1f53 3532 struct scsi_disk *sdkp = dev_get_drvdata(dev);
1da177e4
LT
3533
3534 if (!sdkp)
3535 return; /* this can happen */
3536
54f57588 3537 if (pm_runtime_suspended(dev))
3d9a1f53 3538 return;
54f57588 3539
95897910 3540 if (sdkp->WCE && sdkp->media_present) {
e73aec82 3541 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
4fa83244 3542 sd_sync_cache(sdkp, NULL);
39b7f1e2 3543 }
c3c94c5a 3544
cc5d2c8c
JB
3545 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3546 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3547 sd_start_stop_device(sdkp, 0);
c3c94c5a 3548 }
39b7f1e2 3549}
1da177e4 3550
95897910 3551static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
c3c94c5a 3552{
3d9a1f53 3553 struct scsi_disk *sdkp = dev_get_drvdata(dev);
4fa83244 3554 struct scsi_sense_hdr sshdr;
09ff92fe 3555 int ret = 0;
c3c94c5a 3556
13b43891
AS
3557 if (!sdkp) /* E.g.: runtime suspend following sd_remove() */
3558 return 0;
c3c94c5a 3559
95897910 3560 if (sdkp->WCE && sdkp->media_present) {
cc5d2c8c 3561 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
4fa83244
DB
3562 ret = sd_sync_cache(sdkp, &sshdr);
3563
95897910
ON
3564 if (ret) {
3565 /* ignore OFFLINE device */
3566 if (ret == -ENODEV)
4fa83244
DB
3567 return 0;
3568
3569 if (!scsi_sense_valid(&sshdr) ||
3570 sshdr.sense_key != ILLEGAL_REQUEST)
3571 return ret;
3572
3573 /*
3574 * sshdr.sense_key == ILLEGAL_REQUEST means this drive
3575 * doesn't support sync. There's not much to do and
3576 * suspend shouldn't fail.
3577 */
ed91f7ed 3578 ret = 0;
95897910 3579 }
c3c94c5a
TH
3580 }
3581
691e3d31 3582 if (sdkp->device->manage_start_stop) {
cc5d2c8c 3583 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
95897910 3584 /* an error is not worth aborting a system sleep */
cc5d2c8c 3585 ret = sd_start_stop_device(sdkp, 0);
95897910
ON
3586 if (ignore_stop_errors)
3587 ret = 0;
c3c94c5a
TH
3588 }
3589
09ff92fe 3590 return ret;
c3c94c5a
TH
3591}
3592
95897910
ON
3593static int sd_suspend_system(struct device *dev)
3594{
3595 return sd_suspend_common(dev, true);
3596}
3597
3598static int sd_suspend_runtime(struct device *dev)
3599{
3600 return sd_suspend_common(dev, false);
3601}
3602
c3c94c5a
TH
3603static int sd_resume(struct device *dev)
3604{
3d9a1f53 3605 struct scsi_disk *sdkp = dev_get_drvdata(dev);
d80210f2 3606 int ret;
c3c94c5a 3607
13b43891
AS
3608 if (!sdkp) /* E.g.: runtime resume at the start of sd_probe() */
3609 return 0;
3610
cc5d2c8c 3611 if (!sdkp->device->manage_start_stop)
3d9a1f53 3612 return 0;
c3c94c5a 3613
cc5d2c8c 3614 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
d80210f2
CH
3615 ret = sd_start_stop_device(sdkp, 1);
3616 if (!ret)
3617 opal_unlock_from_suspend(sdkp->opal_dev);
3618 return ret;
c3c94c5a
TH
3619}
3620
1da177e4
LT
3621/**
3622 * init_sd - entry point for this driver (both when built in or when
3623 * a module).
3624 *
3625 * Note: this function registers this driver with the scsi mid-level.
3626 **/
3627static int __init init_sd(void)
3628{
5e4009ba 3629 int majors = 0, i, err;
1da177e4
LT
3630
3631 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3632
0761df9c
HR
3633 for (i = 0; i < SD_MAJORS; i++) {
3634 if (register_blkdev(sd_major(i), "sd") != 0)
3635 continue;
3636 majors++;
3637 blk_register_region(sd_major(i), SD_MINORS, NULL,
3638 sd_default_probe, NULL, NULL);
3639 }
1da177e4
LT
3640
3641 if (!majors)
3642 return -ENODEV;
3643
5e4009ba
JG
3644 err = class_register(&sd_disk_class);
3645 if (err)
3646 goto err_out;
6bdaa1f1 3647
4e7392ec
MP
3648 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3649 0, 0, NULL);
3650 if (!sd_cdb_cache) {
3651 printk(KERN_ERR "sd: can't init extended cdb cache\n");
8d964478 3652 err = -ENOMEM;
4e7392ec
MP
3653 goto err_out_class;
3654 }
3655
3656 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3657 if (!sd_cdb_pool) {
3658 printk(KERN_ERR "sd: can't init extended cdb pool\n");
8d964478 3659 err = -ENOMEM;
4e7392ec
MP
3660 goto err_out_cache;
3661 }
3662
61cce6f6
JA
3663 sd_page_pool = mempool_create_page_pool(SD_MEMPOOL_SIZE, 0);
3664 if (!sd_page_pool) {
3665 printk(KERN_ERR "sd: can't init discard page pool\n");
3666 err = -ENOMEM;
3667 goto err_out_ppool;
3668 }
3669
afd5e34b
JD
3670 err = scsi_register_driver(&sd_template.gendrv);
3671 if (err)
3672 goto err_out_driver;
3673
5e4009ba
JG
3674 return 0;
3675
afd5e34b 3676err_out_driver:
61cce6f6
JA
3677 mempool_destroy(sd_page_pool);
3678
3679err_out_ppool:
afd5e34b
JD
3680 mempool_destroy(sd_cdb_pool);
3681
4e7392ec
MP
3682err_out_cache:
3683 kmem_cache_destroy(sd_cdb_cache);
3684
5e4009ba
JG
3685err_out_class:
3686 class_unregister(&sd_disk_class);
3687err_out:
3688 for (i = 0; i < SD_MAJORS; i++)
3689 unregister_blkdev(sd_major(i), "sd");
3690 return err;
1da177e4
LT
3691}
3692
3693/**
3694 * exit_sd - exit point for this driver (when it is a module).
3695 *
3696 * Note: this function unregisters this driver from the scsi mid-level.
3697 **/
3698static void __exit exit_sd(void)
3699{
3700 int i;
3701
3702 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3703
afd5e34b 3704 scsi_unregister_driver(&sd_template.gendrv);
4e7392ec 3705 mempool_destroy(sd_cdb_pool);
61cce6f6 3706 mempool_destroy(sd_page_pool);
4e7392ec
MP
3707 kmem_cache_destroy(sd_cdb_cache);
3708
5e4009ba
JG
3709 class_unregister(&sd_disk_class);
3710
0761df9c
HR
3711 for (i = 0; i < SD_MAJORS; i++) {
3712 blk_unregister_region(sd_major(i), SD_MINORS);
1da177e4 3713 unregister_blkdev(sd_major(i), "sd");
0761df9c 3714 }
1da177e4
LT
3715}
3716
1da177e4
LT
3717module_init(init_sd);
3718module_exit(exit_sd);
e73aec82
MP
3719
3720static void sd_print_sense_hdr(struct scsi_disk *sdkp,
3721 struct scsi_sense_hdr *sshdr)
3722{
21045519
HR
3723 scsi_print_sense_hdr(sdkp->device,
3724 sdkp->disk ? sdkp->disk->disk_name : NULL, sshdr);
e73aec82
MP
3725}
3726
ef61329d
HR
3727static void sd_print_result(const struct scsi_disk *sdkp, const char *msg,
3728 int result)
e73aec82 3729{
ef61329d
HR
3730 const char *hb_string = scsi_hostbyte_string(result);
3731 const char *db_string = scsi_driverbyte_string(result);
3732
3733 if (hb_string || db_string)
3734 sd_printk(KERN_INFO, sdkp,
3735 "%s: Result: hostbyte=%s driverbyte=%s\n", msg,
3736 hb_string ? hb_string : "invalid",
3737 db_string ? db_string : "invalid");
3738 else
3739 sd_printk(KERN_INFO, sdkp,
3740 "%s: Result: hostbyte=0x%02x driverbyte=0x%02x\n",
3741 msg, host_byte(result), driver_byte(result));
e73aec82
MP
3742}
3743