]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - drivers/scsi/sd.c
scsi: libsas: Remove scsi_to_u32()
[mirror_ubuntu-eoan-kernel.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
cf64e5a5 1152static blk_status_t sd_setup_read_write_cmnd(struct scsi_cmnd *cmd)
1da177e4 1153{
cf64e5a5
BVA
1154 struct request *rq = cmd->request;
1155 struct scsi_device *sdp = cmd->device;
e249e42d 1156 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
ec029758 1157 sector_t lba = sectors_to_logical(sdp, blk_rq_pos(rq));
18351070 1158 sector_t threshold;
ec029758 1159 unsigned int nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
e249e42d 1160 bool dif, dix;
ec029758 1161 unsigned int mask = logical_to_sectors(sdp, 1) - 1;
78a02f49
MP
1162 bool write = rq_data_dir(rq) == WRITE;
1163 unsigned char protect, fua;
159b2cbf 1164 blk_status_t ret;
7f9a6bc4 1165
cf64e5a5 1166 ret = scsi_init_io(cmd);
159b2cbf 1167 if (ret != BLK_STS_OK)
39051dd8 1168 return ret;
e249e42d 1169
cf64e5a5 1170 WARN_ON_ONCE(cmd != rq->special);
7f9a6bc4 1171
e249e42d 1172 if (!scsi_device_online(sdp) || sdp->changed) {
cf64e5a5 1173 scmd_printk(KERN_ERR, cmd, "device offline or changed\n");
159b2cbf 1174 return BLK_STS_IOERR;
1da177e4
LT
1175 }
1176
e249e42d 1177 if (blk_rq_pos(rq) + blk_rq_sectors(rq) > get_capacity(rq->rq_disk)) {
cf64e5a5 1178 scmd_printk(KERN_ERR, cmd, "access beyond end of device\n");
e249e42d
MP
1179 return BLK_STS_IOERR;
1180 }
1181
1182 if ((blk_rq_pos(rq) & mask) || (blk_rq_sectors(rq) & mask)) {
cf64e5a5 1183 scmd_printk(KERN_ERR, cmd, "request not aligned to the logical block size\n");
159b2cbf 1184 return BLK_STS_IOERR;
1da177e4 1185 }
7f9a6bc4 1186
a0899d4d 1187 /*
ec029758
MP
1188 * Some SD card readers can't handle accesses which touch the
1189 * last one or two logical blocks. Split accesses as needed.
a0899d4d 1190 */
ec029758 1191 threshold = sdkp->capacity - SD_LAST_BUGGY_SECTORS;
18351070 1192
c6c93fdd
MP
1193 if (unlikely(sdp->last_sector_bug && lba + nr_blocks > threshold)) {
1194 if (lba < threshold) {
18351070 1195 /* Access up to the threshold but not beyond */
c6c93fdd 1196 nr_blocks = threshold - lba;
18351070 1197 } else {
ec029758
MP
1198 /* Access only a single logical block */
1199 nr_blocks = 1;
18351070
LT
1200 }
1201 }
a0899d4d 1202
78a02f49 1203 fua = rq->cmd_flags & REQ_FUA ? 0x8 : 0;
cf64e5a5
BVA
1204 dix = scsi_prot_sg_count(cmd);
1205 dif = scsi_host_dif_capable(cmd->device->host, sdkp->protection_type);
c611529e 1206
e249e42d 1207 if (write && dix)
cf64e5a5 1208 t10_pi_prepare(cmd->request, sdkp->protection_type);
e249e42d 1209
c611529e 1210 if (dif || dix)
cf64e5a5 1211 protect = sd_setup_protect_cmnd(cmd, dix, dif);
af55ff67 1212 else
4e7392ec
MP
1213 protect = 0;
1214
8475c811 1215 if (protect && sdkp->protection_type == T10_PI_TYPE2_PROTECTION) {
cf64e5a5 1216 ret = sd_setup_rw32_cmnd(cmd, write, lba, nr_blocks,
78a02f49 1217 protect | fua);
c6c93fdd 1218 } else if (sdp->use_16_for_rw || (nr_blocks > 0xffff)) {
cf64e5a5 1219 ret = sd_setup_rw16_cmnd(cmd, write, lba, nr_blocks,
78a02f49 1220 protect | fua);
c6c93fdd 1221 } else if ((nr_blocks > 0xff) || (lba > 0x1fffff) ||
e249e42d 1222 sdp->use_10_for_rw || protect) {
cf64e5a5 1223 ret = sd_setup_rw10_cmnd(cmd, write, lba, nr_blocks,
78a02f49 1224 protect | fua);
1da177e4 1225 } else {
cf64e5a5 1226 ret = sd_setup_rw6_cmnd(cmd, write, lba, nr_blocks,
78a02f49 1227 protect | fua);
1da177e4 1228 }
78a02f49
MP
1229
1230 if (unlikely(ret != BLK_STS_OK))
1231 return ret;
1232
1da177e4
LT
1233 /*
1234 * We shouldn't disconnect in the middle of a sector, so with a dumb
1235 * host adapter, it's safe to assume that we can at least transfer
1236 * this many bytes between each connect / disconnect.
1237 */
cf64e5a5
BVA
1238 cmd->transfersize = sdp->sector_size;
1239 cmd->underflow = nr_blocks << 9;
1240 cmd->allowed = SD_MAX_RETRIES;
1241 cmd->sdb.length = nr_blocks * sdp->sector_size;
e249e42d
MP
1242
1243 SCSI_LOG_HLQUEUE(1,
cf64e5a5 1244 scmd_printk(KERN_INFO, cmd,
e249e42d
MP
1245 "%s: block=%llu, count=%d\n", __func__,
1246 (unsigned long long)blk_rq_pos(rq),
1247 blk_rq_sectors(rq)));
1248 SCSI_LOG_HLQUEUE(2,
cf64e5a5 1249 scmd_printk(KERN_INFO, cmd,
e249e42d
MP
1250 "%s %d/%u 512 byte blocks.\n",
1251 write ? "writing" : "reading", nr_blocks,
1252 blk_rq_sectors(rq)));
1da177e4 1253
1da177e4
LT
1254 /*
1255 * This indicates that the command is ready from our end to be
1256 * queued.
1257 */
159b2cbf 1258 return BLK_STS_OK;
1da177e4
LT
1259}
1260
159b2cbf 1261static blk_status_t sd_init_command(struct scsi_cmnd *cmd)
87949eee
CH
1262{
1263 struct request *rq = cmd->request;
1264
c2df40df
MC
1265 switch (req_op(rq)) {
1266 case REQ_OP_DISCARD:
81d926e8
CH
1267 switch (scsi_disk(rq->rq_disk)->provisioning_mode) {
1268 case SD_LBP_UNMAP:
1269 return sd_setup_unmap_cmnd(cmd);
1270 case SD_LBP_WS16:
02d26103 1271 return sd_setup_write_same16_cmnd(cmd, true);
81d926e8
CH
1272 case SD_LBP_WS10:
1273 return sd_setup_write_same10_cmnd(cmd, true);
1274 case SD_LBP_ZERO:
1275 return sd_setup_write_same10_cmnd(cmd, false);
1276 default:
159b2cbf 1277 return BLK_STS_TARGET;
81d926e8 1278 }
02d26103
CH
1279 case REQ_OP_WRITE_ZEROES:
1280 return sd_setup_write_zeroes_cmnd(cmd);
c2df40df 1281 case REQ_OP_WRITE_SAME:
87949eee 1282 return sd_setup_write_same_cmnd(cmd);
3a5e02ce 1283 case REQ_OP_FLUSH:
87949eee 1284 return sd_setup_flush_cmnd(cmd);
c2df40df
MC
1285 case REQ_OP_READ:
1286 case REQ_OP_WRITE:
87949eee 1287 return sd_setup_read_write_cmnd(cmd);
89d94756
HR
1288 case REQ_OP_ZONE_RESET:
1289 return sd_zbc_setup_reset_cmnd(cmd);
c2df40df 1290 default:
f1f1fada 1291 WARN_ON_ONCE(1);
159b2cbf 1292 return BLK_STS_NOTSUPP;
c2df40df 1293 }
87949eee
CH
1294}
1295
1296static void sd_uninit_command(struct scsi_cmnd *SCpnt)
1297{
1298 struct request *rq = SCpnt->request;
14e3062f 1299 u8 *cmnd;
87949eee 1300
f9d03f96 1301 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
61cce6f6 1302 mempool_free(rq->special_vec.bv_page, sd_page_pool);
87949eee 1303
82ed4db4 1304 if (SCpnt->cmnd != scsi_req(rq)->cmd) {
14e3062f 1305 cmnd = SCpnt->cmnd;
87949eee
CH
1306 SCpnt->cmnd = NULL;
1307 SCpnt->cmd_len = 0;
14e3062f 1308 mempool_free(cmnd, sd_cdb_pool);
87949eee
CH
1309 }
1310}
1311
1da177e4
LT
1312/**
1313 * sd_open - open a scsi disk device
7529fbb0
DLM
1314 * @bdev: Block device of the scsi disk to open
1315 * @mode: FMODE_* mask
1da177e4
LT
1316 *
1317 * Returns 0 if successful. Returns a negated errno value in case
1318 * of error.
1319 *
1320 * Note: This can be called from a user context (e.g. fsck(1) )
1321 * or from within the kernel (e.g. as a result of a mount(1) ).
1322 * In the latter case @inode and @filp carry an abridged amount
1323 * of information as noted above.
409f3499
AB
1324 *
1325 * Locking: called with bdev->bd_mutex held.
1da177e4 1326 **/
0338e291 1327static int sd_open(struct block_device *bdev, fmode_t mode)
1da177e4 1328{
0338e291 1329 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
1da177e4
LT
1330 struct scsi_device *sdev;
1331 int retval;
1332
0338e291 1333 if (!sdkp)
1da177e4
LT
1334 return -ENXIO;
1335
fa0d34be 1336 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
1da177e4
LT
1337
1338 sdev = sdkp->device;
1339
1340 /*
1341 * If the device is in error recovery, wait until it is done.
1342 * If the device is offline, then disallow any access to it.
1343 */
1344 retval = -ENXIO;
1345 if (!scsi_block_when_processing_errors(sdev))
1346 goto error_out;
1347
1348 if (sdev->removable || sdkp->write_prot)
0338e291 1349 check_disk_change(bdev);
1da177e4
LT
1350
1351 /*
1352 * If the drive is empty, just let the open fail.
1353 */
1354 retval = -ENOMEDIUM;
0338e291 1355 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
1da177e4
LT
1356 goto error_out;
1357
1358 /*
1359 * If the device has the write protect tab set, have the open fail
1360 * if the user expects to be able to write to the thing.
1361 */
1362 retval = -EROFS;
0338e291 1363 if (sdkp->write_prot && (mode & FMODE_WRITE))
1da177e4
LT
1364 goto error_out;
1365
1366 /*
1367 * It is possible that the disk changing stuff resulted in
1368 * the device being taken offline. If this is the case,
1369 * report this to the user, and don't pretend that the
1370 * open actually succeeded.
1371 */
1372 retval = -ENXIO;
1373 if (!scsi_device_online(sdev))
1374 goto error_out;
1375
409f3499 1376 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
1da177e4
LT
1377 if (scsi_block_when_processing_errors(sdev))
1378 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1379 }
1380
1381 return 0;
1382
1383error_out:
1384 scsi_disk_put(sdkp);
1385 return retval;
1386}
1387
1388/**
1389 * sd_release - invoked when the (last) close(2) is called on this
1390 * scsi disk.
7529fbb0
DLM
1391 * @disk: disk to release
1392 * @mode: FMODE_* mask
1da177e4
LT
1393 *
1394 * Returns 0.
1395 *
1396 * Note: may block (uninterruptible) if error recovery is underway
1397 * on this disk.
409f3499
AB
1398 *
1399 * Locking: called with bdev->bd_mutex held.
1da177e4 1400 **/
db2a144b 1401static void sd_release(struct gendisk *disk, fmode_t mode)
1da177e4 1402{
1da177e4
LT
1403 struct scsi_disk *sdkp = scsi_disk(disk);
1404 struct scsi_device *sdev = sdkp->device;
1405
56937f7b 1406 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1da177e4 1407
7e443312 1408 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
1da177e4
LT
1409 if (scsi_block_when_processing_errors(sdev))
1410 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1411 }
1412
1413 /*
1414 * XXX and what if there are packets in flight and this close()
1415 * XXX is followed by a "rmmod sd_mod"?
1416 */
478a8a05 1417
1da177e4 1418 scsi_disk_put(sdkp);
1da177e4
LT
1419}
1420
a885c8c4 1421static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1da177e4
LT
1422{
1423 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1424 struct scsi_device *sdp = sdkp->device;
1425 struct Scsi_Host *host = sdp->host;
f08bb1e0 1426 sector_t capacity = logical_to_sectors(sdp, sdkp->capacity);
1da177e4
LT
1427 int diskinfo[4];
1428
1429 /* default to most commonly used values */
f08bb1e0
MP
1430 diskinfo[0] = 0x40; /* 1 << 6 */
1431 diskinfo[1] = 0x20; /* 1 << 5 */
1432 diskinfo[2] = capacity >> 11;
1433
1da177e4
LT
1434 /* override with calculated, extended default, or driver values */
1435 if (host->hostt->bios_param)
f08bb1e0 1436 host->hostt->bios_param(sdp, bdev, capacity, diskinfo);
1da177e4 1437 else
f08bb1e0 1438 scsicam_bios_param(bdev, capacity, diskinfo);
1da177e4 1439
a885c8c4
CH
1440 geo->heads = diskinfo[0];
1441 geo->sectors = diskinfo[1];
1442 geo->cylinders = diskinfo[2];
1da177e4
LT
1443 return 0;
1444}
1445
1446/**
1447 * sd_ioctl - process an ioctl
7529fbb0
DLM
1448 * @bdev: target block device
1449 * @mode: FMODE_* mask
1da177e4
LT
1450 * @cmd: ioctl command number
1451 * @arg: this is third argument given to ioctl(2) system call.
1452 * Often contains a pointer.
1453 *
25985edc 1454 * Returns 0 if successful (some ioctls return positive numbers on
1da177e4
LT
1455 * success as well). Returns a negated errno value in case of error.
1456 *
1457 * Note: most ioctls are forward onto the block subsystem or further
3a4fa0a2 1458 * down in the scsi subsystem.
1da177e4 1459 **/
0338e291 1460static int sd_ioctl(struct block_device *bdev, fmode_t mode,
1da177e4
LT
1461 unsigned int cmd, unsigned long arg)
1462{
1da177e4 1463 struct gendisk *disk = bdev->bd_disk;
fe2d1851
NN
1464 struct scsi_disk *sdkp = scsi_disk(disk);
1465 struct scsi_device *sdp = sdkp->device;
1da177e4
LT
1466 void __user *p = (void __user *)arg;
1467 int error;
1468
fe2d1851
NN
1469 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1470 "cmd=0x%x\n", disk->disk_name, cmd));
1da177e4 1471
0bfc96cb
PB
1472 error = scsi_verify_blk_ioctl(bdev, cmd);
1473 if (error < 0)
1474 return error;
1475
1da177e4
LT
1476 /*
1477 * If we are in the middle of error recovery, don't let anyone
1478 * else try and use this device. Also, if error recovery fails, it
1479 * may try and take the device offline, in which case all further
1480 * access to the device is prohibited.
1481 */
906d15fb
CH
1482 error = scsi_ioctl_block_when_processing_errors(sdp, cmd,
1483 (mode & FMODE_NDELAY) != 0);
1484 if (error)
8a6cfeb6 1485 goto out;
1da177e4 1486
d80210f2
CH
1487 if (is_sed_ioctl(cmd))
1488 return sed_ioctl(sdkp->opal_dev, cmd, p);
1489
1da177e4
LT
1490 /*
1491 * Send SCSI addressing ioctls directly to mid level, send other
1492 * ioctls to block level and then onto mid level if they can't be
1493 * resolved.
1494 */
1495 switch (cmd) {
1496 case SCSI_IOCTL_GET_IDLUN:
1497 case SCSI_IOCTL_GET_BUS_NUMBER:
8a6cfeb6
AB
1498 error = scsi_ioctl(sdp, cmd, p);
1499 break;
1da177e4 1500 default:
577ebb37 1501 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
1da177e4 1502 if (error != -ENOTTY)
8a6cfeb6
AB
1503 break;
1504 error = scsi_ioctl(sdp, cmd, p);
1505 break;
1da177e4 1506 }
8a6cfeb6 1507out:
8a6cfeb6 1508 return error;
1da177e4
LT
1509}
1510
1511static void set_media_not_present(struct scsi_disk *sdkp)
1512{
2bae0093
TH
1513 if (sdkp->media_present)
1514 sdkp->device->changed = 1;
1515
1516 if (sdkp->device->removable) {
1517 sdkp->media_present = 0;
1518 sdkp->capacity = 0;
1519 }
1520}
1521
1522static int media_not_present(struct scsi_disk *sdkp,
1523 struct scsi_sense_hdr *sshdr)
1524{
1525 if (!scsi_sense_valid(sshdr))
1526 return 0;
1527
1528 /* not invoked for commands that could return deferred errors */
1529 switch (sshdr->sense_key) {
1530 case UNIT_ATTENTION:
1531 case NOT_READY:
1532 /* medium not present */
1533 if (sshdr->asc == 0x3A) {
1534 set_media_not_present(sdkp);
1535 return 1;
1536 }
1537 }
1538 return 0;
1da177e4
LT
1539}
1540
1541/**
2bae0093
TH
1542 * sd_check_events - check media events
1543 * @disk: kernel device descriptor
1544 * @clearing: disk events currently being cleared
1da177e4 1545 *
2bae0093 1546 * Returns mask of DISK_EVENT_*.
1da177e4
LT
1547 *
1548 * Note: this function is invoked from the block subsystem.
1549 **/
2bae0093 1550static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
1da177e4 1551{
eb72d0bb
HR
1552 struct scsi_disk *sdkp = scsi_disk_get(disk);
1553 struct scsi_device *sdp;
1da177e4
LT
1554 int retval;
1555
eb72d0bb
HR
1556 if (!sdkp)
1557 return 0;
1558
1559 sdp = sdkp->device;
2bae0093 1560 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
1da177e4
LT
1561
1562 /*
1563 * If the device is offline, don't send any commands - just pretend as
1564 * if the command failed. If the device ever comes back online, we
1565 * can deal with it then. It is only because of unrecoverable errors
1566 * that we would ever take a device offline in the first place.
1567 */
285e9670
KS
1568 if (!scsi_device_online(sdp)) {
1569 set_media_not_present(sdkp);
285e9670
KS
1570 goto out;
1571 }
1da177e4
LT
1572
1573 /*
1574 * Using TEST_UNIT_READY enables differentiation between drive with
1575 * no cartridge loaded - NOT READY, drive with changed cartridge -
1576 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1577 *
1578 * Drives that auto spin down. eg iomega jaz 1G, will be started
1579 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1580 * sd_revalidate() is called.
1581 */
001aac25 1582 if (scsi_block_when_processing_errors(sdp)) {
6fa2b8f9
CH
1583 struct scsi_sense_hdr sshdr = { 0, };
1584
001aac25 1585 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
6fa2b8f9 1586 &sshdr);
1da177e4 1587
6fa2b8f9
CH
1588 /* failed to execute TUR, assume media not present */
1589 if (host_byte(retval)) {
1590 set_media_not_present(sdkp);
1591 goto out;
1592 }
1da177e4 1593
6fa2b8f9
CH
1594 if (media_not_present(sdkp, &sshdr))
1595 goto out;
1596 }
2bae0093 1597
1da177e4
LT
1598 /*
1599 * For removable scsi disk we have to recognise the presence
2bae0093 1600 * of a disk in the drive.
1da177e4 1601 */
2bae0093
TH
1602 if (!sdkp->media_present)
1603 sdp->changed = 1;
1da177e4 1604 sdkp->media_present = 1;
285e9670 1605out:
3ff5588d 1606 /*
2bae0093 1607 * sdp->changed is set under the following conditions:
3ff5588d 1608 *
2bae0093
TH
1609 * Medium present state has changed in either direction.
1610 * Device has indicated UNIT_ATTENTION.
3ff5588d 1611 */
2bae0093
TH
1612 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1613 sdp->changed = 0;
eb72d0bb 1614 scsi_disk_put(sdkp);
1da177e4 1615 return retval;
1da177e4
LT
1616}
1617
4fa83244 1618static int sd_sync_cache(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
1da177e4 1619{
1da177e4 1620 int retries, res;
e73aec82 1621 struct scsi_device *sdp = sdkp->device;
7e660100
JB
1622 const int timeout = sdp->request_queue->rq_timeout
1623 * SD_FLUSH_TIMEOUT_MULTIPLIER;
4fa83244 1624 struct scsi_sense_hdr my_sshdr;
1da177e4
LT
1625
1626 if (!scsi_device_online(sdp))
1627 return -ENODEV;
1628
4fa83244
DB
1629 /* caller might not be interested in sense, but we need it */
1630 if (!sshdr)
1631 sshdr = &my_sshdr;
1632
1da177e4
LT
1633 for (retries = 3; retries > 0; --retries) {
1634 unsigned char cmd[10] = { 0 };
1635
1636 cmd[0] = SYNCHRONIZE_CACHE;
1637 /*
1638 * Leave the rest of the command zero to indicate
1639 * flush everything.
1640 */
4fa83244 1641 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, sshdr,
fcbfffe2 1642 timeout, SD_MAX_RETRIES, 0, RQF_PM, NULL);
ea73a9f2 1643 if (res == 0)
1da177e4
LT
1644 break;
1645 }
1646
e73aec82 1647 if (res) {
ef61329d 1648 sd_print_result(sdkp, "Synchronize Cache(10) failed", res);
95897910 1649
c65be1a6 1650 if (driver_byte(res) == DRIVER_SENSE)
4fa83244
DB
1651 sd_print_sense_hdr(sdkp, sshdr);
1652
95897910 1653 /* we need to evaluate the error return */
4fa83244
DB
1654 if (scsi_sense_valid(sshdr) &&
1655 (sshdr->asc == 0x3a || /* medium not present */
1656 sshdr->asc == 0x20)) /* invalid command */
95897910
ON
1657 /* this is no error here */
1658 return 0;
1659
1660 switch (host_byte(res)) {
1661 /* ignore errors due to racing a disconnection */
1662 case DID_BAD_TARGET:
1663 case DID_NO_CONNECT:
1664 return 0;
1665 /* signal the upper layer it might try again */
1666 case DID_BUS_BUSY:
1667 case DID_IMM_RETRY:
1668 case DID_REQUEUE:
1669 case DID_SOFT_ERROR:
1670 return -EBUSY;
1671 default:
1672 return -EIO;
1673 }
1da177e4 1674 }
3721050a 1675 return 0;
1da177e4
LT
1676}
1677
1da177e4
LT
1678static void sd_rescan(struct device *dev)
1679{
3d9a1f53 1680 struct scsi_disk *sdkp = dev_get_drvdata(dev);
39b7f1e2 1681
3d9a1f53 1682 revalidate_disk(sdkp->disk);
1da177e4
LT
1683}
1684
1685
1686#ifdef CONFIG_COMPAT
1687/*
1688 * This gets directly called from VFS. When the ioctl
1689 * is not recognized we go back to the other translation paths.
1690 */
0338e291
AV
1691static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1692 unsigned int cmd, unsigned long arg)
1da177e4 1693{
0338e291 1694 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
21a9d4c9 1695 int error;
1da177e4 1696
21a9d4c9
CH
1697 error = scsi_ioctl_block_when_processing_errors(sdev, cmd,
1698 (mode & FMODE_NDELAY) != 0);
1699 if (error)
1700 return error;
1da177e4 1701
1da177e4
LT
1702 /*
1703 * Let the static ioctl translation table take care of it.
1704 */
21a9d4c9
CH
1705 if (!sdev->host->hostt->compat_ioctl)
1706 return -ENOIOCTLCMD;
1707 return sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
1da177e4
LT
1708}
1709#endif
1710
924d55b0
CH
1711static char sd_pr_type(enum pr_type type)
1712{
1713 switch (type) {
1714 case PR_WRITE_EXCLUSIVE:
1715 return 0x01;
1716 case PR_EXCLUSIVE_ACCESS:
1717 return 0x03;
1718 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1719 return 0x05;
1720 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1721 return 0x06;
1722 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1723 return 0x07;
1724 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1725 return 0x08;
1726 default:
1727 return 0;
1728 }
1729};
1730
1731static int sd_pr_command(struct block_device *bdev, u8 sa,
1732 u64 key, u64 sa_key, u8 type, u8 flags)
1733{
1734 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1735 struct scsi_sense_hdr sshdr;
1736 int result;
1737 u8 cmd[16] = { 0, };
1738 u8 data[24] = { 0, };
1739
1740 cmd[0] = PERSISTENT_RESERVE_OUT;
1741 cmd[1] = sa;
1742 cmd[2] = type;
1743 put_unaligned_be32(sizeof(data), &cmd[5]);
1744
1745 put_unaligned_be64(key, &data[0]);
1746 put_unaligned_be64(sa_key, &data[8]);
1747 data[20] = flags;
1748
1749 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, &data, sizeof(data),
1750 &sshdr, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1751
c65be1a6
JT
1752 if (driver_byte(result) == DRIVER_SENSE &&
1753 scsi_sense_valid(&sshdr)) {
924d55b0
CH
1754 sdev_printk(KERN_INFO, sdev, "PR command failed: %d\n", result);
1755 scsi_print_sense_hdr(sdev, NULL, &sshdr);
1756 }
1757
1758 return result;
1759}
1760
1761static int sd_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
1762 u32 flags)
1763{
1764 if (flags & ~PR_FL_IGNORE_KEY)
1765 return -EOPNOTSUPP;
1766 return sd_pr_command(bdev, (flags & PR_FL_IGNORE_KEY) ? 0x06 : 0x00,
1767 old_key, new_key, 0,
01f90dd9 1768 (1 << 0) /* APTPL */);
924d55b0
CH
1769}
1770
1771static int sd_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
1772 u32 flags)
1773{
1774 if (flags)
1775 return -EOPNOTSUPP;
1776 return sd_pr_command(bdev, 0x01, key, 0, sd_pr_type(type), 0);
1777}
1778
1779static int sd_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1780{
1781 return sd_pr_command(bdev, 0x02, key, 0, sd_pr_type(type), 0);
1782}
1783
1784static int sd_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
1785 enum pr_type type, bool abort)
1786{
1787 return sd_pr_command(bdev, abort ? 0x05 : 0x04, old_key, new_key,
1788 sd_pr_type(type), 0);
1789}
1790
1791static int sd_pr_clear(struct block_device *bdev, u64 key)
1792{
1793 return sd_pr_command(bdev, 0x03, key, 0, 0, 0);
1794}
1795
1796static const struct pr_ops sd_pr_ops = {
1797 .pr_register = sd_pr_register,
1798 .pr_reserve = sd_pr_reserve,
1799 .pr_release = sd_pr_release,
1800 .pr_preempt = sd_pr_preempt,
1801 .pr_clear = sd_pr_clear,
1802};
1803
83d5cde4 1804static const struct block_device_operations sd_fops = {
1da177e4 1805 .owner = THIS_MODULE,
0338e291
AV
1806 .open = sd_open,
1807 .release = sd_release,
8a6cfeb6 1808 .ioctl = sd_ioctl,
a885c8c4 1809 .getgeo = sd_getgeo,
1da177e4 1810#ifdef CONFIG_COMPAT
0338e291 1811 .compat_ioctl = sd_compat_ioctl,
1da177e4 1812#endif
2bae0093 1813 .check_events = sd_check_events,
1da177e4 1814 .revalidate_disk = sd_revalidate_disk,
72ec24bd 1815 .unlock_native_capacity = sd_unlock_native_capacity,
e76239a3 1816 .report_zones = sd_zbc_report_zones,
924d55b0 1817 .pr_ops = &sd_pr_ops,
1da177e4
LT
1818};
1819
7a38dc0b
HR
1820/**
1821 * sd_eh_reset - reset error handling callback
1822 * @scmd: sd-issued command that has failed
1823 *
1824 * This function is called by the SCSI midlayer before starting
1825 * SCSI EH. When counting medium access failures we have to be
1826 * careful to register it only only once per device and SCSI EH run;
1827 * there might be several timed out commands which will cause the
1828 * 'max_medium_access_timeouts' counter to trigger after the first
1829 * SCSI EH run already and set the device to offline.
1830 * So this function resets the internal counter before starting SCSI EH.
1831 **/
1832static void sd_eh_reset(struct scsi_cmnd *scmd)
1833{
1834 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1835
1836 /* New SCSI EH run, reset gate variable */
1837 sdkp->ignore_medium_access_errors = false;
1838}
1839
18a4d0a2
MP
1840/**
1841 * sd_eh_action - error handling callback
1842 * @scmd: sd-issued command that has failed
18a4d0a2
MP
1843 * @eh_disp: The recovery disposition suggested by the midlayer
1844 *
2451079b
JB
1845 * This function is called by the SCSI midlayer upon completion of an
1846 * error test command (currently TEST UNIT READY). The result of sending
1847 * the eh command is passed in eh_disp. We're looking for devices that
1848 * fail medium access commands but are OK with non access commands like
1849 * test unit ready (so wrongly see the device as having a successful
1850 * recovery)
18a4d0a2 1851 **/
2451079b 1852static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
18a4d0a2
MP
1853{
1854 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
0db6ca8a 1855 struct scsi_device *sdev = scmd->device;
18a4d0a2 1856
0db6ca8a 1857 if (!scsi_device_online(sdev) ||
2451079b
JB
1858 !scsi_medium_access_command(scmd) ||
1859 host_byte(scmd->result) != DID_TIME_OUT ||
1860 eh_disp != SUCCESS)
18a4d0a2
MP
1861 return eh_disp;
1862
1863 /*
1864 * The device has timed out executing a medium access command.
1865 * However, the TEST UNIT READY command sent during error
1866 * handling completed successfully. Either the device is in the
1867 * process of recovering or has it suffered an internal failure
1868 * that prevents access to the storage medium.
1869 */
7a38dc0b
HR
1870 if (!sdkp->ignore_medium_access_errors) {
1871 sdkp->medium_access_timed_out++;
1872 sdkp->ignore_medium_access_errors = true;
1873 }
18a4d0a2
MP
1874
1875 /*
1876 * If the device keeps failing read/write commands but TEST UNIT
1877 * READY always completes successfully we assume that medium
1878 * access is no longer possible and take the device offline.
1879 */
1880 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1881 scmd_printk(KERN_ERR, scmd,
1882 "Medium access timeout failure. Offlining disk!\n");
0db6ca8a
BVA
1883 mutex_lock(&sdev->state_mutex);
1884 scsi_device_set_state(sdev, SDEV_OFFLINE);
1885 mutex_unlock(&sdev->state_mutex);
18a4d0a2 1886
e8f8d50e 1887 return SUCCESS;
18a4d0a2
MP
1888 }
1889
1890 return eh_disp;
1891}
1892
af55ff67
MP
1893static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1894{
6eadc612
DLM
1895 struct request *req = scmd->request;
1896 struct scsi_device *sdev = scmd->device;
1897 unsigned int transferred, good_bytes;
1898 u64 start_lba, end_lba, bad_lba;
1899
a8733c7b 1900 /*
6eadc612
DLM
1901 * Some commands have a payload smaller than the device logical
1902 * block size (e.g. INQUIRY on a 4K disk).
a8733c7b 1903 */
6eadc612 1904 if (scsi_bufflen(scmd) <= sdev->sector_size)
af55ff67
MP
1905 return 0;
1906
6eadc612
DLM
1907 /* Check if we have a 'bad_lba' information */
1908 if (!scsi_get_sense_info_fld(scmd->sense_buffer,
1909 SCSI_SENSE_BUFFERSIZE,
1910 &bad_lba))
af55ff67
MP
1911 return 0;
1912
6eadc612
DLM
1913 /*
1914 * If the bad lba was reported incorrectly, we have no idea where
af55ff67
MP
1915 * the error is.
1916 */
6eadc612
DLM
1917 start_lba = sectors_to_logical(sdev, blk_rq_pos(req));
1918 end_lba = start_lba + bytes_to_logical(sdev, scsi_bufflen(scmd));
1919 if (bad_lba < start_lba || bad_lba >= end_lba)
af55ff67
MP
1920 return 0;
1921
6eadc612
DLM
1922 /*
1923 * resid is optional but mostly filled in. When it's unused,
1924 * its value is zero, so we assume the whole buffer transferred
af55ff67 1925 */
6eadc612
DLM
1926 transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
1927
1928 /* This computation should always be done in terms of the
1929 * resolution of the device's medium.
af55ff67 1930 */
6eadc612
DLM
1931 good_bytes = logical_to_bytes(sdev, bad_lba - start_lba);
1932
a8733c7b 1933 return min(good_bytes, transferred);
af55ff67
MP
1934}
1935
1da177e4 1936/**
7b3d9545 1937 * sd_done - bottom half handler: called when the lower level
1da177e4
LT
1938 * driver has completed (successfully or otherwise) a scsi command.
1939 * @SCpnt: mid-level's per command structure.
1940 *
1941 * Note: potentially run from within an ISR. Must not block.
1942 **/
7b3d9545 1943static int sd_done(struct scsi_cmnd *SCpnt)
1da177e4
LT
1944{
1945 int result = SCpnt->result;
af55ff67 1946 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
c46f0917
DLM
1947 unsigned int sector_size = SCpnt->device->sector_size;
1948 unsigned int resid;
1da177e4 1949 struct scsi_sense_hdr sshdr;
4e7392ec 1950 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
26e85fcd 1951 struct request *req = SCpnt->request;
1da177e4
LT
1952 int sense_valid = 0;
1953 int sense_deferred = 0;
1da177e4 1954
89d94756
HR
1955 switch (req_op(req)) {
1956 case REQ_OP_DISCARD:
02d26103 1957 case REQ_OP_WRITE_ZEROES:
89d94756
HR
1958 case REQ_OP_WRITE_SAME:
1959 case REQ_OP_ZONE_RESET:
26e85fcd
MP
1960 if (!result) {
1961 good_bytes = blk_rq_bytes(req);
1962 scsi_set_resid(SCpnt, 0);
1963 } else {
1964 good_bytes = 0;
1965 scsi_set_resid(SCpnt, blk_rq_bytes(req));
89d94756
HR
1966 }
1967 break;
c46f0917
DLM
1968 default:
1969 /*
1970 * In case of bogus fw or device, we could end up having
1971 * an unaligned partial completion. Check this here and force
1972 * alignment.
1973 */
1974 resid = scsi_get_resid(SCpnt);
1975 if (resid & (sector_size - 1)) {
1976 sd_printk(KERN_INFO, sdkp,
1977 "Unaligned partial completion (resid=%u, sector_sz=%u)\n",
1978 resid, sector_size);
1979 resid = min(scsi_bufflen(SCpnt),
1980 round_up(resid, sector_size));
1981 scsi_set_resid(SCpnt, resid);
1982 }
26e85fcd 1983 }
6a32a8ae 1984
1da177e4
LT
1985 if (result) {
1986 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1987 if (sense_valid)
1988 sense_deferred = scsi_sense_is_deferred(&sshdr);
1989 }
2a863ba8
DJ
1990 sdkp->medium_access_timed_out = 0;
1991
03aba2f7
LT
1992 if (driver_byte(result) != DRIVER_SENSE &&
1993 (!sense_valid || sense_deferred))
1994 goto out;
1995
1996 switch (sshdr.sense_key) {
1997 case HARDWARE_ERROR:
1998 case MEDIUM_ERROR:
af55ff67 1999 good_bytes = sd_completed_bytes(SCpnt);
03aba2f7
LT
2000 break;
2001 case RECOVERED_ERROR:
af55ff67
MP
2002 good_bytes = scsi_bufflen(SCpnt);
2003 break;
10dab226
JW
2004 case NO_SENSE:
2005 /* This indicates a false check condition, so ignore it. An
2006 * unknown amount of data was transferred so treat it as an
2007 * error.
2008 */
10dab226
JW
2009 SCpnt->result = 0;
2010 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2011 break;
c98a0eb0
MP
2012 case ABORTED_COMMAND:
2013 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
2014 good_bytes = sd_completed_bytes(SCpnt);
2015 break;
2016 case ILLEGAL_REQUEST:
d227ec26
CH
2017 switch (sshdr.asc) {
2018 case 0x10: /* DIX: Host detected corruption */
af55ff67 2019 good_bytes = sd_completed_bytes(SCpnt);
d227ec26
CH
2020 break;
2021 case 0x20: /* INVALID COMMAND OPCODE */
2022 case 0x24: /* INVALID FIELD IN CDB */
2023 switch (SCpnt->cmnd[0]) {
5db44863
MP
2024 case UNMAP:
2025 sd_config_discard(sdkp, SD_LBP_DISABLE);
2026 break;
2027 case WRITE_SAME_16:
2028 case WRITE_SAME:
d227ec26 2029 if (SCpnt->cmnd[1] & 8) { /* UNMAP */
5db44863 2030 sd_config_discard(sdkp, SD_LBP_DISABLE);
d227ec26 2031 } else {
5db44863
MP
2032 sdkp->device->no_write_same = 1;
2033 sd_config_write_same(sdkp);
e8064021 2034 req->rq_flags |= RQF_QUIET;
5db44863 2035 }
d227ec26 2036 break;
5db44863
MP
2037 }
2038 }
03aba2f7
LT
2039 break;
2040 default:
2041 break;
1da177e4 2042 }
89d94756 2043
03aba2f7 2044 out:
89d94756
HR
2045 if (sd_is_zoned(sdkp))
2046 sd_zbc_complete(SCpnt, good_bytes, &sshdr);
2047
ef61329d
HR
2048 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
2049 "sd_done: completed %d of %d bytes\n",
2050 good_bytes, scsi_bufflen(SCpnt)));
2051
10c41ddd
MG
2052 if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt) &&
2053 good_bytes)
2054 t10_pi_complete(SCpnt->request, sdkp->protection_type,
2055 good_bytes / scsi_prot_interval(SCpnt));
af55ff67 2056
7b3d9545 2057 return good_bytes;
1da177e4
LT
2058}
2059
1da177e4
LT
2060/*
2061 * spinup disk - called only in sd_revalidate_disk()
2062 */
2063static void
e73aec82 2064sd_spinup_disk(struct scsi_disk *sdkp)
ea73a9f2 2065{
1da177e4 2066 unsigned char cmd[10];
4451e472 2067 unsigned long spintime_expire = 0;
1da177e4
LT
2068 int retries, spintime;
2069 unsigned int the_result;
2070 struct scsi_sense_hdr sshdr;
2071 int sense_valid = 0;
2072
2073 spintime = 0;
2074
2075 /* Spin up drives, as required. Only do this at boot time */
2076 /* Spinup needs to be done for module loads too. */
2077 do {
2078 retries = 0;
2079
2080 do {
2081 cmd[0] = TEST_UNIT_READY;
2082 memset((void *) &cmd[1], 0, 9);
2083
ea73a9f2
JB
2084 the_result = scsi_execute_req(sdkp->device, cmd,
2085 DMA_NONE, NULL, 0,
2086 &sshdr, SD_TIMEOUT,
f4f4e47e 2087 SD_MAX_RETRIES, NULL);
1da177e4 2088
b4d38e38
AS
2089 /*
2090 * If the drive has indicated to us that it
2091 * doesn't have any media in it, don't bother
2092 * with any more polling.
2093 */
2094 if (media_not_present(sdkp, &sshdr))
2095 return;
2096
1da177e4 2097 if (the_result)
ea73a9f2 2098 sense_valid = scsi_sense_valid(&sshdr);
1da177e4
LT
2099 retries++;
2100 } while (retries < 3 &&
2101 (!scsi_status_is_good(the_result) ||
c65be1a6 2102 ((driver_byte(the_result) == DRIVER_SENSE) &&
1da177e4
LT
2103 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
2104
c65be1a6 2105 if (driver_byte(the_result) != DRIVER_SENSE) {
1da177e4
LT
2106 /* no sense, TUR either succeeded or failed
2107 * with a status error */
e73aec82 2108 if(!spintime && !scsi_status_is_good(the_result)) {
ef61329d
HR
2109 sd_print_result(sdkp, "Test Unit Ready failed",
2110 the_result);
e73aec82 2111 }
1da177e4
LT
2112 break;
2113 }
ef61329d 2114
1da177e4
LT
2115 /*
2116 * The device does not want the automatic start to be issued.
2117 */
33dd6f92 2118 if (sdkp->device->no_start_on_add)
1da177e4 2119 break;
1da177e4 2120
33dd6f92
MW
2121 if (sense_valid && sshdr.sense_key == NOT_READY) {
2122 if (sshdr.asc == 4 && sshdr.ascq == 3)
2123 break; /* manual intervention required */
2124 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
2125 break; /* standby */
2126 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
2127 break; /* unavailable */
505aa4b6
MR
2128 if (sshdr.asc == 4 && sshdr.ascq == 0x1b)
2129 break; /* sanitize in progress */
33dd6f92
MW
2130 /*
2131 * Issue command to spin up drive when not ready
2132 */
1da177e4 2133 if (!spintime) {
e73aec82 2134 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1da177e4
LT
2135 cmd[0] = START_STOP;
2136 cmd[1] = 1; /* Return immediately */
2137 memset((void *) &cmd[2], 0, 8);
2138 cmd[4] = 1; /* Start spin cycle */
d2886ea3
SR
2139 if (sdkp->device->start_stop_pwr_cond)
2140 cmd[4] |= 1 << 4;
ea73a9f2
JB
2141 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
2142 NULL, 0, &sshdr,
f4f4e47e
FT
2143 SD_TIMEOUT, SD_MAX_RETRIES,
2144 NULL);
4451e472
AS
2145 spintime_expire = jiffies + 100 * HZ;
2146 spintime = 1;
1da177e4 2147 }
1da177e4
LT
2148 /* Wait 1 second for next try */
2149 msleep(1000);
3a1d0783 2150 printk(KERN_CONT ".");
4451e472
AS
2151
2152 /*
2153 * Wait for USB flash devices with slow firmware.
2154 * Yes, this sense key/ASC combination shouldn't
2155 * occur here. It's characteristic of these devices.
2156 */
2157 } else if (sense_valid &&
2158 sshdr.sense_key == UNIT_ATTENTION &&
2159 sshdr.asc == 0x28) {
2160 if (!spintime) {
2161 spintime_expire = jiffies + 5 * HZ;
2162 spintime = 1;
2163 }
2164 /* Wait 1 second for next try */
2165 msleep(1000);
1da177e4
LT
2166 } else {
2167 /* we don't understand the sense code, so it's
2168 * probably pointless to loop */
2169 if(!spintime) {
e73aec82
MP
2170 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
2171 sd_print_sense_hdr(sdkp, &sshdr);
1da177e4
LT
2172 }
2173 break;
2174 }
2175
4451e472 2176 } while (spintime && time_before_eq(jiffies, spintime_expire));
1da177e4
LT
2177
2178 if (spintime) {
2179 if (scsi_status_is_good(the_result))
3a1d0783 2180 printk(KERN_CONT "ready\n");
1da177e4 2181 else
3a1d0783 2182 printk(KERN_CONT "not responding...\n");
1da177e4
LT
2183 }
2184}
2185
e0597d70
MP
2186/*
2187 * Determine whether disk supports Data Integrity Field.
2188 */
fe542396 2189static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
e0597d70
MP
2190{
2191 struct scsi_device *sdp = sdkp->device;
2192 u8 type;
fe542396 2193 int ret = 0;
e0597d70
MP
2194
2195 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
fe542396 2196 return ret;
35e1a5d9
MP
2197
2198 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
2199
8475c811 2200 if (type > T10_PI_TYPE3_PROTECTION)
fe542396
MP
2201 ret = -ENODEV;
2202 else if (scsi_host_dif_capable(sdp->host, type))
2203 ret = 1;
2204
2205 if (sdkp->first_scan || type != sdkp->protection_type)
2206 switch (ret) {
2207 case -ENODEV:
2208 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
2209 " protection type %u. Disabling disk!\n",
2210 type);
2211 break;
2212 case 1:
2213 sd_printk(KERN_NOTICE, sdkp,
2214 "Enabling DIF Type %u protection\n", type);
2215 break;
2216 case 0:
2217 sd_printk(KERN_NOTICE, sdkp,
2218 "Disabling DIF Type %u protection\n", type);
2219 break;
2220 }
e0597d70 2221
be922f47
MP
2222 sdkp->protection_type = type;
2223
fe542396 2224 return ret;
e0597d70
MP
2225}
2226
0da205e0
MW
2227static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
2228 struct scsi_sense_hdr *sshdr, int sense_valid,
2229 int the_result)
2230{
c65be1a6 2231 if (driver_byte(the_result) == DRIVER_SENSE)
0da205e0
MW
2232 sd_print_sense_hdr(sdkp, sshdr);
2233 else
2234 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
2235
2236 /*
2237 * Set dirty bit for removable devices if not ready -
2238 * sometimes drives will not report this properly.
2239 */
2240 if (sdp->removable &&
2241 sense_valid && sshdr->sense_key == NOT_READY)
2bae0093 2242 set_media_not_present(sdkp);
0da205e0
MW
2243
2244 /*
2245 * We used to set media_present to 0 here to indicate no media
2246 * in the drive, but some drives fail read capacity even with
2247 * media present, so we can't do that.
2248 */
2249 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
2250}
2251
2252#define RC16_LEN 32
2253#if RC16_LEN > SD_BUF_SIZE
2254#error RC16_LEN must not be more than SD_BUF_SIZE
2255#endif
2256
3233ac19
JB
2257#define READ_CAPACITY_RETRIES_ON_RESET 10
2258
7c856152
MP
2259/*
2260 * Ensure that we don't overflow sector_t when CONFIG_LBDAF is not set
2261 * and the reported logical block size is bigger than 512 bytes. Note
2262 * that last_sector is a u64 and therefore logical_to_sectors() is not
2263 * applicable.
2264 */
2265static bool sd_addressable_capacity(u64 lba, unsigned int sector_size)
2266{
2267 u64 last_sector = (lba + 1ULL) << (ilog2(sector_size) - 9);
2268
2269 if (sizeof(sector_t) == 4 && last_sector > U32_MAX)
2270 return false;
2271
2272 return true;
2273}
2274
0da205e0
MW
2275static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
2276 unsigned char *buffer)
ea73a9f2 2277{
1da177e4 2278 unsigned char cmd[16];
1da177e4
LT
2279 struct scsi_sense_hdr sshdr;
2280 int sense_valid = 0;
0da205e0 2281 int the_result;
3233ac19 2282 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
ea09bcc9 2283 unsigned int alignment;
0da205e0
MW
2284 unsigned long long lba;
2285 unsigned sector_size;
1da177e4 2286
5ce524bd
HG
2287 if (sdp->no_read_capacity_16)
2288 return -EINVAL;
2289
1da177e4 2290 do {
0da205e0 2291 memset(cmd, 0, 16);
eb846d9f 2292 cmd[0] = SERVICE_ACTION_IN_16;
0da205e0
MW
2293 cmd[1] = SAI_READ_CAPACITY_16;
2294 cmd[13] = RC16_LEN;
2295 memset(buffer, 0, RC16_LEN);
2296
ea73a9f2 2297 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
0da205e0
MW
2298 buffer, RC16_LEN, &sshdr,
2299 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1da177e4 2300
ea73a9f2 2301 if (media_not_present(sdkp, &sshdr))
0da205e0 2302 return -ENODEV;
1da177e4 2303
2b301307 2304 if (the_result) {
ea73a9f2 2305 sense_valid = scsi_sense_valid(&sshdr);
2b301307
MW
2306 if (sense_valid &&
2307 sshdr.sense_key == ILLEGAL_REQUEST &&
2308 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
2309 sshdr.ascq == 0x00)
2310 /* Invalid Command Operation Code or
2311 * Invalid Field in CDB, just retry
2312 * silently with RC10 */
2313 return -EINVAL;
3233ac19
JB
2314 if (sense_valid &&
2315 sshdr.sense_key == UNIT_ATTENTION &&
2316 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2317 /* Device reset might occur several times,
2318 * give it one more chance */
2319 if (--reset_retries > 0)
2320 continue;
2b301307 2321 }
1da177e4
LT
2322 retries--;
2323
2324 } while (the_result && retries);
2325
0da205e0 2326 if (the_result) {
ef61329d 2327 sd_print_result(sdkp, "Read Capacity(16) failed", the_result);
0da205e0
MW
2328 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2329 return -EINVAL;
2330 }
e73aec82 2331
8f76d151
DH
2332 sector_size = get_unaligned_be32(&buffer[8]);
2333 lba = get_unaligned_be64(&buffer[0]);
0da205e0 2334
fe542396
MP
2335 if (sd_read_protection_type(sdkp, buffer) < 0) {
2336 sdkp->capacity = 0;
2337 return -ENODEV;
2338 }
0da205e0 2339
7c856152 2340 if (!sd_addressable_capacity(lba, sector_size)) {
0da205e0
MW
2341 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2342 "kernel compiled with support for large block "
2343 "devices.\n");
2344 sdkp->capacity = 0;
2345 return -EOVERFLOW;
2346 }
2347
ea09bcc9 2348 /* Logical blocks per physical block exponent */
526f7c79 2349 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
ea09bcc9 2350
89d94756
HR
2351 /* RC basis */
2352 sdkp->rc_basis = (buffer[12] >> 4) & 0x3;
2353
ea09bcc9
MP
2354 /* Lowest aligned logical block */
2355 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2356 blk_queue_alignment_offset(sdp->request_queue, alignment);
2357 if (alignment && sdkp->first_scan)
2358 sd_printk(KERN_NOTICE, sdkp,
2359 "physical block alignment offset: %u\n", alignment);
2360
c98a0eb0
MP
2361 if (buffer[14] & 0x80) { /* LBPME */
2362 sdkp->lbpme = 1;
e339c1a7 2363
c98a0eb0
MP
2364 if (buffer[14] & 0x40) /* LBPRZ */
2365 sdkp->lbprz = 1;
e339c1a7 2366
c98a0eb0 2367 sd_config_discard(sdkp, SD_LBP_WS16);
e339c1a7
MP
2368 }
2369
0da205e0
MW
2370 sdkp->capacity = lba + 1;
2371 return sector_size;
2372}
2373
2374static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2375 unsigned char *buffer)
2376{
2377 unsigned char cmd[16];
2378 struct scsi_sense_hdr sshdr;
2379 int sense_valid = 0;
2380 int the_result;
3233ac19 2381 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
0da205e0
MW
2382 sector_t lba;
2383 unsigned sector_size;
2384
2385 do {
2386 cmd[0] = READ_CAPACITY;
2387 memset(&cmd[1], 0, 9);
2388 memset(buffer, 0, 8);
2389
2390 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2391 buffer, 8, &sshdr,
2392 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2393
2394 if (media_not_present(sdkp, &sshdr))
2395 return -ENODEV;
2396
3233ac19 2397 if (the_result) {
0da205e0 2398 sense_valid = scsi_sense_valid(&sshdr);
3233ac19
JB
2399 if (sense_valid &&
2400 sshdr.sense_key == UNIT_ATTENTION &&
2401 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2402 /* Device reset might occur several times,
2403 * give it one more chance */
2404 if (--reset_retries > 0)
2405 continue;
2406 }
0da205e0
MW
2407 retries--;
2408
2409 } while (the_result && retries);
2410
2411 if (the_result) {
ef61329d 2412 sd_print_result(sdkp, "Read Capacity(10) failed", the_result);
0da205e0
MW
2413 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2414 return -EINVAL;
2415 }
2416
8f76d151
DH
2417 sector_size = get_unaligned_be32(&buffer[4]);
2418 lba = get_unaligned_be32(&buffer[0]);
0da205e0 2419
5ce524bd
HG
2420 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2421 /* Some buggy (usb cardreader) devices return an lba of
2422 0xffffffff when the want to report a size of 0 (with
2423 which they really mean no media is present) */
2424 sdkp->capacity = 0;
5cc10350 2425 sdkp->physical_block_size = sector_size;
5ce524bd
HG
2426 return sector_size;
2427 }
2428
7c856152 2429 if (!sd_addressable_capacity(lba, sector_size)) {
0da205e0
MW
2430 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2431 "kernel compiled with support for large block "
2432 "devices.\n");
2433 sdkp->capacity = 0;
2434 return -EOVERFLOW;
2435 }
2436
2437 sdkp->capacity = lba + 1;
526f7c79 2438 sdkp->physical_block_size = sector_size;
0da205e0
MW
2439 return sector_size;
2440}
2441
2b301307
MW
2442static int sd_try_rc16_first(struct scsi_device *sdp)
2443{
f87146bb
HR
2444 if (sdp->host->max_cmd_len < 16)
2445 return 0;
6a0bdffa
AS
2446 if (sdp->try_rc_10_first)
2447 return 0;
2b301307
MW
2448 if (sdp->scsi_level > SCSI_SPC_2)
2449 return 1;
2450 if (scsi_device_protection(sdp))
2451 return 1;
2452 return 0;
2453}
2454
0da205e0
MW
2455/*
2456 * read disk capacity
2457 */
2458static void
2459sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2460{
2461 int sector_size;
2462 struct scsi_device *sdp = sdkp->device;
2463
2b301307 2464 if (sd_try_rc16_first(sdp)) {
0da205e0
MW
2465 sector_size = read_capacity_16(sdkp, sdp, buffer);
2466 if (sector_size == -EOVERFLOW)
1da177e4 2467 goto got_data;
2b301307
MW
2468 if (sector_size == -ENODEV)
2469 return;
2470 if (sector_size < 0)
2471 sector_size = read_capacity_10(sdkp, sdp, buffer);
0da205e0
MW
2472 if (sector_size < 0)
2473 return;
1da177e4 2474 } else {
0da205e0
MW
2475 sector_size = read_capacity_10(sdkp, sdp, buffer);
2476 if (sector_size == -EOVERFLOW)
2477 goto got_data;
2478 if (sector_size < 0)
2479 return;
2480 if ((sizeof(sdkp->capacity) > 4) &&
2481 (sdkp->capacity > 0xffffffffULL)) {
2482 int old_sector_size = sector_size;
2483 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2484 "Trying to use READ CAPACITY(16).\n");
2485 sector_size = read_capacity_16(sdkp, sdp, buffer);
2486 if (sector_size < 0) {
2487 sd_printk(KERN_NOTICE, sdkp,
2488 "Using 0xffffffff as device size\n");
2489 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2490 sector_size = old_sector_size;
2491 goto got_data;
2492 }
597d7400
MP
2493 /* Remember that READ CAPACITY(16) succeeded */
2494 sdp->try_rc_10_first = 0;
0da205e0
MW
2495 }
2496 }
1da177e4 2497
5c211caa
AS
2498 /* Some devices are known to return the total number of blocks,
2499 * not the highest block number. Some devices have versions
2500 * which do this and others which do not. Some devices we might
2501 * suspect of doing this but we don't know for certain.
2502 *
2503 * If we know the reported capacity is wrong, decrement it. If
2504 * we can only guess, then assume the number of blocks is even
2505 * (usually true but not always) and err on the side of lowering
2506 * the capacity.
2507 */
2508 if (sdp->fix_capacity ||
2509 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2510 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2511 "from its reported value: %llu\n",
2512 (unsigned long long) sdkp->capacity);
1da177e4 2513 --sdkp->capacity;
61bf54b7
ON
2514 }
2515
1da177e4
LT
2516got_data:
2517 if (sector_size == 0) {
2518 sector_size = 512;
e73aec82
MP
2519 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2520 "assuming 512.\n");
1da177e4
LT
2521 }
2522
2523 if (sector_size != 512 &&
2524 sector_size != 1024 &&
2525 sector_size != 2048 &&
74856fbf 2526 sector_size != 4096) {
e73aec82
MP
2527 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2528 sector_size);
1da177e4
LT
2529 /*
2530 * The user might want to re-format the drive with
2531 * a supported sectorsize. Once this happens, it
2532 * would be relatively trivial to set the thing up.
2533 * For this reason, we leave the thing in the table.
2534 */
2535 sdkp->capacity = 0;
2536 /*
2537 * set a bogus sector size so the normal read/write
2538 * logic in the block layer will eventually refuse any
2539 * request on this device without tripping over power
2540 * of two sector size assumptions
2541 */
2542 sector_size = 512;
2543 }
e1defc4f 2544 blk_queue_logical_block_size(sdp->request_queue, sector_size);
89d94756
HR
2545 blk_queue_physical_block_size(sdp->request_queue,
2546 sdkp->physical_block_size);
2547 sdkp->device->sector_size = sector_size;
7404ad3b 2548
89d94756
HR
2549 if (sdkp->capacity > 0xffffffff)
2550 sdp->use_16_for_rw = 1;
1da177e4 2551
89d94756 2552}
1da177e4 2553
89d94756
HR
2554/*
2555 * Print disk capacity
2556 */
2557static void
2558sd_print_capacity(struct scsi_disk *sdkp,
2559 sector_t old_capacity)
2560{
2561 int sector_size = sdkp->device->sector_size;
2562 char cap_str_2[10], cap_str_10[10];
ea09bcc9 2563
89d94756
HR
2564 string_get_size(sdkp->capacity, sector_size,
2565 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
2566 string_get_size(sdkp->capacity, sector_size,
2567 STRING_UNITS_10, cap_str_10,
2568 sizeof(cap_str_10));
1da177e4 2569
89d94756
HR
2570 if (sdkp->first_scan || old_capacity != sdkp->capacity) {
2571 sd_printk(KERN_NOTICE, sdkp,
2572 "%llu %d-byte logical blocks: (%s/%s)\n",
2573 (unsigned long long)sdkp->capacity,
2574 sector_size, cap_str_10, cap_str_2);
53ad570b 2575
89d94756
HR
2576 if (sdkp->physical_block_size != sector_size)
2577 sd_printk(KERN_NOTICE, sdkp,
2578 "%u-byte physical blocks\n",
2579 sdkp->physical_block_size);
2580
2581 sd_zbc_print_zones(sdkp);
2582 }
1da177e4
LT
2583}
2584
2585/* called with buffer of length 512 */
2586static inline int
ea73a9f2
JB
2587sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
2588 unsigned char *buffer, int len, struct scsi_mode_data *data,
2589 struct scsi_sense_hdr *sshdr)
1da177e4 2590{
ea73a9f2 2591 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1cf72699 2592 SD_TIMEOUT, SD_MAX_RETRIES, data,
ea73a9f2 2593 sshdr);
1da177e4
LT
2594}
2595
2596/*
2597 * read write protect setting, if possible - called only in sd_revalidate_disk()
48970800 2598 * called with buffer of length SD_BUF_SIZE
1da177e4
LT
2599 */
2600static void
e73aec82 2601sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
ea73a9f2 2602{
1da177e4 2603 int res;
ea73a9f2 2604 struct scsi_device *sdp = sdkp->device;
1da177e4 2605 struct scsi_mode_data data;
20bd1d02 2606 int disk_ro = get_disk_ro(sdkp->disk);
70a9b873 2607 int old_wp = sdkp->write_prot;
1da177e4
LT
2608
2609 set_disk_ro(sdkp->disk, 0);
ea73a9f2 2610 if (sdp->skip_ms_page_3f) {
b2bff6ce 2611 sd_first_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
1da177e4
LT
2612 return;
2613 }
2614
ea73a9f2
JB
2615 if (sdp->use_192_bytes_for_3f) {
2616 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1da177e4
LT
2617 } else {
2618 /*
2619 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2620 * We have to start carefully: some devices hang if we ask
2621 * for more than is available.
2622 */
ea73a9f2 2623 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1da177e4
LT
2624
2625 /*
2626 * Second attempt: ask for page 0 When only page 0 is
2627 * implemented, a request for page 3F may return Sense Key
2628 * 5: Illegal Request, Sense Code 24: Invalid field in
2629 * CDB.
2630 */
2631 if (!scsi_status_is_good(res))
ea73a9f2 2632 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1da177e4
LT
2633
2634 /*
2635 * Third attempt: ask 255 bytes, as we did earlier.
2636 */
2637 if (!scsi_status_is_good(res))
ea73a9f2
JB
2638 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
2639 &data, NULL);
1da177e4
LT
2640 }
2641
2642 if (!scsi_status_is_good(res)) {
b2bff6ce 2643 sd_first_printk(KERN_WARNING, sdkp,
e73aec82 2644 "Test WP failed, assume Write Enabled\n");
1da177e4
LT
2645 } else {
2646 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
20bd1d02 2647 set_disk_ro(sdkp->disk, sdkp->write_prot || disk_ro);
70a9b873
MP
2648 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2649 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2650 sdkp->write_prot ? "on" : "off");
df441cc0 2651 sd_printk(KERN_DEBUG, sdkp, "Mode Sense: %4ph\n", buffer);
70a9b873 2652 }
1da177e4
LT
2653 }
2654}
2655
2656/*
2657 * sd_read_cache_type - called only from sd_revalidate_disk()
48970800 2658 * called with buffer of length SD_BUF_SIZE
1da177e4
LT
2659 */
2660static void
e73aec82 2661sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
631e8a13 2662{
1da177e4 2663 int len = 0, res;
ea73a9f2 2664 struct scsi_device *sdp = sdkp->device;
1da177e4 2665
631e8a13
AV
2666 int dbd;
2667 int modepage;
0bcaa111 2668 int first_len;
1da177e4
LT
2669 struct scsi_mode_data data;
2670 struct scsi_sense_hdr sshdr;
70a9b873
MP
2671 int old_wce = sdkp->WCE;
2672 int old_rcd = sdkp->RCD;
2673 int old_dpofua = sdkp->DPOFUA;
1da177e4 2674
39c60a09
JB
2675
2676 if (sdkp->cache_override)
2677 return;
2678
0bcaa111
LT
2679 first_len = 4;
2680 if (sdp->skip_ms_page_8) {
2681 if (sdp->type == TYPE_RBC)
2682 goto defaults;
2683 else {
2684 if (sdp->skip_ms_page_3f)
2685 goto defaults;
2686 modepage = 0x3F;
2687 if (sdp->use_192_bytes_for_3f)
2688 first_len = 192;
2689 dbd = 0;
2690 }
2691 } else if (sdp->type == TYPE_RBC) {
631e8a13
AV
2692 modepage = 6;
2693 dbd = 8;
2694 } else {
2695 modepage = 8;
2696 dbd = 0;
2697 }
2698
1da177e4 2699 /* cautiously ask */
0bcaa111
LT
2700 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2701 &data, &sshdr);
1da177e4
LT
2702
2703 if (!scsi_status_is_good(res))
2704 goto bad_sense;
2705
6d73c851
AV
2706 if (!data.header_length) {
2707 modepage = 6;
0bcaa111 2708 first_len = 0;
b2bff6ce
MP
2709 sd_first_printk(KERN_ERR, sdkp,
2710 "Missing header in MODE_SENSE response\n");
6d73c851
AV
2711 }
2712
1da177e4
LT
2713 /* that went OK, now ask for the proper length */
2714 len = data.length;
2715
2716 /*
2717 * We're only interested in the first three bytes, actually.
2718 * But the data cache page is defined for the first 20.
2719 */
2720 if (len < 3)
2721 goto bad_sense;
0bcaa111 2722 else if (len > SD_BUF_SIZE) {
b2bff6ce 2723 sd_first_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
0bcaa111
LT
2724 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2725 len = SD_BUF_SIZE;
2726 }
2727 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2728 len = 192;
1da177e4
LT
2729
2730 /* Get the data */
0bcaa111
LT
2731 if (len > first_len)
2732 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2733 &data, &sshdr);
1da177e4
LT
2734
2735 if (scsi_status_is_good(res)) {
631e8a13 2736 int offset = data.header_length + data.block_descriptor_length;
1da177e4 2737
0bcaa111
LT
2738 while (offset < len) {
2739 u8 page_code = buffer[offset] & 0x3F;
2740 u8 spf = buffer[offset] & 0x40;
2741
2742 if (page_code == 8 || page_code == 6) {
2743 /* We're interested only in the first 3 bytes.
2744 */
2745 if (len - offset <= 2) {
b2bff6ce
MP
2746 sd_first_printk(KERN_ERR, sdkp,
2747 "Incomplete mode parameter "
2748 "data\n");
0bcaa111
LT
2749 goto defaults;
2750 } else {
2751 modepage = page_code;
2752 goto Page_found;
2753 }
2754 } else {
2755 /* Go to the next page */
2756 if (spf && len - offset > 3)
2757 offset += 4 + (buffer[offset+2] << 8) +
2758 buffer[offset+3];
2759 else if (!spf && len - offset > 1)
2760 offset += 2 + buffer[offset+1];
2761 else {
b2bff6ce
MP
2762 sd_first_printk(KERN_ERR, sdkp,
2763 "Incomplete mode "
2764 "parameter data\n");
0bcaa111
LT
2765 goto defaults;
2766 }
2767 }
48970800
AV
2768 }
2769
b2bff6ce 2770 sd_first_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
984f1733
AS
2771 goto defaults;
2772
0bcaa111 2773 Page_found:
631e8a13
AV
2774 if (modepage == 8) {
2775 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2776 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2777 } else {
2778 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2779 sdkp->RCD = 0;
2780 }
1da177e4 2781
007365ad 2782 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
b14bf2d0
AS
2783 if (sdp->broken_fua) {
2784 sd_first_printk(KERN_NOTICE, sdkp, "Disabling FUA\n");
2785 sdkp->DPOFUA = 0;
26f28197
DLM
2786 } else if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw &&
2787 !sdkp->device->use_16_for_rw) {
b2bff6ce 2788 sd_first_printk(KERN_NOTICE, sdkp,
e73aec82 2789 "Uses READ/WRITE(6), disabling FUA\n");
007365ad
TH
2790 sdkp->DPOFUA = 0;
2791 }
2792
2eefd57b
SRT
2793 /* No cache flush allowed for write protected devices */
2794 if (sdkp->WCE && sdkp->write_prot)
2795 sdkp->WCE = 0;
2796
70a9b873
MP
2797 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2798 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2799 sd_printk(KERN_NOTICE, sdkp,
2800 "Write cache: %s, read cache: %s, %s\n",
2801 sdkp->WCE ? "enabled" : "disabled",
2802 sdkp->RCD ? "disabled" : "enabled",
2803 sdkp->DPOFUA ? "supports DPO and FUA"
2804 : "doesn't support DPO or FUA");
1da177e4
LT
2805
2806 return;
2807 }
2808
2809bad_sense:
ea73a9f2 2810 if (scsi_sense_valid(&sshdr) &&
1da177e4
LT
2811 sshdr.sense_key == ILLEGAL_REQUEST &&
2812 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
e73aec82 2813 /* Invalid field in CDB */
b2bff6ce 2814 sd_first_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
1da177e4 2815 else
b2bff6ce
MP
2816 sd_first_printk(KERN_ERR, sdkp,
2817 "Asking for cache data failed\n");
1da177e4
LT
2818
2819defaults:
b81478d8 2820 if (sdp->wce_default_on) {
b2bff6ce
MP
2821 sd_first_printk(KERN_NOTICE, sdkp,
2822 "Assuming drive cache: write back\n");
b81478d8
NJ
2823 sdkp->WCE = 1;
2824 } else {
b2bff6ce
MP
2825 sd_first_printk(KERN_ERR, sdkp,
2826 "Assuming drive cache: write through\n");
b81478d8
NJ
2827 sdkp->WCE = 0;
2828 }
1da177e4 2829 sdkp->RCD = 0;
48970800 2830 sdkp->DPOFUA = 0;
1da177e4
LT
2831}
2832
e0597d70
MP
2833/*
2834 * The ATO bit indicates whether the DIF application tag is available
2835 * for use by the operating system.
2836 */
439d77f7 2837static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
e0597d70
MP
2838{
2839 int res, offset;
2840 struct scsi_device *sdp = sdkp->device;
2841 struct scsi_mode_data data;
2842 struct scsi_sense_hdr sshdr;
2843
89d94756 2844 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
e0597d70
MP
2845 return;
2846
2847 if (sdkp->protection_type == 0)
2848 return;
2849
2850 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2851 SD_MAX_RETRIES, &data, &sshdr);
2852
2853 if (!scsi_status_is_good(res) || !data.header_length ||
2854 data.length < 6) {
b2bff6ce 2855 sd_first_printk(KERN_WARNING, sdkp,
e0597d70
MP
2856 "getting Control mode page failed, assume no ATO\n");
2857
2858 if (scsi_sense_valid(&sshdr))
2859 sd_print_sense_hdr(sdkp, &sshdr);
2860
2861 return;
2862 }
2863
2864 offset = data.header_length + data.block_descriptor_length;
2865
2866 if ((buffer[offset] & 0x3f) != 0x0a) {
b2bff6ce 2867 sd_first_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
e0597d70
MP
2868 return;
2869 }
2870
2871 if ((buffer[offset + 5] & 0x80) == 0)
2872 return;
2873
2874 sdkp->ATO = 1;
2875
2876 return;
2877}
2878
d11b6916
MP
2879/**
2880 * sd_read_block_limits - Query disk device for preferred I/O sizes.
7529fbb0 2881 * @sdkp: disk to query
d11b6916
MP
2882 */
2883static void sd_read_block_limits(struct scsi_disk *sdkp)
2884{
2885 unsigned int sector_sz = sdkp->device->sector_size;
bb2d3de1 2886 const int vpd_len = 64;
e3deec09 2887 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
d11b6916 2888
e3deec09
JB
2889 if (!buffer ||
2890 /* Block Limits VPD */
2891 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2892 goto out;
d11b6916
MP
2893
2894 blk_queue_io_min(sdkp->disk->queue,
2895 get_unaligned_be16(&buffer[6]) * sector_sz);
ca369d51
MP
2896
2897 sdkp->max_xfer_blocks = get_unaligned_be32(&buffer[8]);
2898 sdkp->opt_xfer_blocks = get_unaligned_be32(&buffer[12]);
d11b6916 2899
c98a0eb0
MP
2900 if (buffer[3] == 0x3c) {
2901 unsigned int lba_count, desc_count;
e339c1a7 2902
5db44863 2903 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
e339c1a7 2904
c98a0eb0 2905 if (!sdkp->lbpme)
045d3fe7 2906 goto out;
045d3fe7 2907
c98a0eb0
MP
2908 lba_count = get_unaligned_be32(&buffer[20]);
2909 desc_count = get_unaligned_be32(&buffer[24]);
045d3fe7 2910
c98a0eb0
MP
2911 if (lba_count && desc_count)
2912 sdkp->max_unmap_blocks = lba_count;
e339c1a7 2913
c98a0eb0 2914 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
e339c1a7
MP
2915
2916 if (buffer[32] & 0x80)
c98a0eb0 2917 sdkp->unmap_alignment =
e339c1a7 2918 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
c98a0eb0
MP
2919
2920 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2921
2922 if (sdkp->max_unmap_blocks)
2923 sd_config_discard(sdkp, SD_LBP_UNMAP);
2924 else
2925 sd_config_discard(sdkp, SD_LBP_WS16);
2926
2927 } else { /* LBP VPD page tells us what to use */
bcd069bb 2928 if (sdkp->lbpu && sdkp->max_unmap_blocks)
e461338b
MP
2929 sd_config_discard(sdkp, SD_LBP_UNMAP);
2930 else if (sdkp->lbpws)
c98a0eb0
MP
2931 sd_config_discard(sdkp, SD_LBP_WS16);
2932 else if (sdkp->lbpws10)
2933 sd_config_discard(sdkp, SD_LBP_WS10);
2934 else
2935 sd_config_discard(sdkp, SD_LBP_DISABLE);
2936 }
e339c1a7
MP
2937 }
2938
e3deec09 2939 out:
d11b6916
MP
2940 kfree(buffer);
2941}
2942
3821d768
MP
2943/**
2944 * sd_read_block_characteristics - Query block dev. characteristics
7529fbb0 2945 * @sdkp: disk to query
3821d768
MP
2946 */
2947static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2948{
89d94756 2949 struct request_queue *q = sdkp->disk->queue;
e3deec09 2950 unsigned char *buffer;
3821d768 2951 u16 rot;
bb2d3de1 2952 const int vpd_len = 64;
3821d768 2953
e3deec09 2954 buffer = kmalloc(vpd_len, GFP_KERNEL);
3821d768 2955
e3deec09
JB
2956 if (!buffer ||
2957 /* Block Device Characteristics VPD */
2958 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2959 goto out;
3821d768
MP
2960
2961 rot = get_unaligned_be16(&buffer[4]);
2962
b277da0a 2963 if (rot == 1) {
8b904b5b
BVA
2964 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
2965 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, q);
83e32a59
XZ
2966 } else {
2967 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
2968 blk_queue_flag_set(QUEUE_FLAG_ADD_RANDOM, q);
b277da0a 2969 }
3821d768 2970
68af412c
DLM
2971 if (sdkp->device->type == TYPE_ZBC) {
2972 /* Host-managed */
89d94756 2973 q->limits.zoned = BLK_ZONED_HM;
68af412c
DLM
2974 } else {
2975 sdkp->zoned = (buffer[8] >> 4) & 3;
2976 if (sdkp->zoned == 1)
2977 /* Host-aware */
2978 q->limits.zoned = BLK_ZONED_HA;
2979 else
2980 /*
2981 * Treat drive-managed devices as
2982 * regular block devices.
2983 */
2984 q->limits.zoned = BLK_ZONED_NONE;
2985 }
89d94756
HR
2986 if (blk_queue_is_zoned(q) && sdkp->first_scan)
2987 sd_printk(KERN_NOTICE, sdkp, "Host-%s zoned block device\n",
2988 q->limits.zoned == BLK_ZONED_HM ? "managed" : "aware");
2989
e3deec09 2990 out:
3821d768
MP
2991 kfree(buffer);
2992}
2993
045d3fe7 2994/**
c98a0eb0 2995 * sd_read_block_provisioning - Query provisioning VPD page
7529fbb0 2996 * @sdkp: disk to query
045d3fe7 2997 */
c98a0eb0 2998static void sd_read_block_provisioning(struct scsi_disk *sdkp)
045d3fe7
MP
2999{
3000 unsigned char *buffer;
3001 const int vpd_len = 8;
3002
c98a0eb0 3003 if (sdkp->lbpme == 0)
045d3fe7
MP
3004 return;
3005
3006 buffer = kmalloc(vpd_len, GFP_KERNEL);
3007
3008 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
3009 goto out;
3010
c98a0eb0
MP
3011 sdkp->lbpvpd = 1;
3012 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
3013 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
3014 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
045d3fe7
MP
3015
3016 out:
3017 kfree(buffer);
3018}
3019
5db44863
MP
3020static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
3021{
66c28f97
MP
3022 struct scsi_device *sdev = sdkp->device;
3023
54b2b50c
MP
3024 if (sdev->host->no_write_same) {
3025 sdev->no_write_same = 1;
3026
3027 return;
3028 }
3029
66c28f97 3030 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
af73623f
BS
3031 /* too large values might cause issues with arcmsr */
3032 int vpd_buf_len = 64;
3033
66c28f97
MP
3034 sdev->no_report_opcodes = 1;
3035
3036 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
3037 * CODES is unsupported and the device has an ATA
3038 * Information VPD page (SAT).
3039 */
af73623f 3040 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
66c28f97
MP
3041 sdev->no_write_same = 1;
3042 }
3043
3044 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
5db44863 3045 sdkp->ws16 = 1;
66c28f97
MP
3046
3047 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
3048 sdkp->ws10 = 1;
5db44863
MP
3049}
3050
d80210f2
CH
3051static void sd_read_security(struct scsi_disk *sdkp, unsigned char *buffer)
3052{
3053 struct scsi_device *sdev = sdkp->device;
3054
3055 if (!sdev->security_supported)
3056 return;
3057
3058 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3059 SECURITY_PROTOCOL_IN) == 1 &&
3060 scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3061 SECURITY_PROTOCOL_OUT) == 1)
3062 sdkp->security = 1;
3063}
3064
1da177e4
LT
3065/**
3066 * sd_revalidate_disk - called the first time a new disk is seen,
3067 * performs disk spin up, read_capacity, etc.
3068 * @disk: struct gendisk we care about
3069 **/
3070static int sd_revalidate_disk(struct gendisk *disk)
3071{
3072 struct scsi_disk *sdkp = scsi_disk(disk);
3073 struct scsi_device *sdp = sdkp->device;
ca369d51 3074 struct request_queue *q = sdkp->disk->queue;
89d94756 3075 sector_t old_capacity = sdkp->capacity;
1da177e4 3076 unsigned char *buffer;
ca369d51 3077 unsigned int dev_max, rw_max;
1da177e4 3078
fa0d34be
MP
3079 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
3080 "sd_revalidate_disk\n"));
1da177e4
LT
3081
3082 /*
3083 * If the device is offline, don't try and read capacity or any
3084 * of the other niceties.
3085 */
3086 if (!scsi_device_online(sdp))
3087 goto out;
3088
a6123f14 3089 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
1da177e4 3090 if (!buffer) {
e73aec82
MP
3091 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
3092 "allocation failure.\n");
ea73a9f2 3093 goto out;
1da177e4
LT
3094 }
3095
e73aec82 3096 sd_spinup_disk(sdkp);
1da177e4
LT
3097
3098 /*
3099 * Without media there is no reason to ask; moreover, some devices
3100 * react badly if we do.
3101 */
3102 if (sdkp->media_present) {
e73aec82 3103 sd_read_capacity(sdkp, buffer);
ffd4bc2a 3104
5ddfe085 3105 if (scsi_device_supports_vpd(sdp)) {
c98a0eb0 3106 sd_read_block_provisioning(sdkp);
ffd4bc2a
MP
3107 sd_read_block_limits(sdkp);
3108 sd_read_block_characteristics(sdkp);
89d94756 3109 sd_zbc_read_zones(sdkp, buffer);
ffd4bc2a
MP
3110 }
3111
89d94756
HR
3112 sd_print_capacity(sdkp, old_capacity);
3113
e73aec82
MP
3114 sd_read_write_protect_flag(sdkp, buffer);
3115 sd_read_cache_type(sdkp, buffer);
e0597d70 3116 sd_read_app_tag_own(sdkp, buffer);
5db44863 3117 sd_read_write_same(sdkp, buffer);
d80210f2 3118 sd_read_security(sdkp, buffer);
1da177e4 3119 }
461d4e90
TH
3120
3121 /*
3122 * We now have all cache related info, determine how we deal
4913efe4 3123 * with flush requests.
461d4e90 3124 */
cb2fb68d 3125 sd_set_flush_flag(sdkp);
461d4e90 3126
ca369d51
MP
3127 /* Initial block count limit based on CDB TRANSFER LENGTH field size. */
3128 dev_max = sdp->use_16_for_rw ? SD_MAX_XFER_BLOCKS : SD_DEF_XFER_BLOCKS;
3129
3130 /* Some devices report a maximum block count for READ/WRITE requests. */
3131 dev_max = min_not_zero(dev_max, sdkp->max_xfer_blocks);
3132 q->limits.max_dev_sectors = logical_to_sectors(sdp, dev_max);
3133
3134 /*
77082ca5 3135 * Determine the device's preferred I/O size for reads and writes
9c1d9c20
MP
3136 * unless the reported value is unreasonably small, large, or
3137 * garbage.
ca369d51 3138 */
9c1d9c20
MP
3139 if (sdkp->opt_xfer_blocks &&
3140 sdkp->opt_xfer_blocks <= dev_max &&
3141 sdkp->opt_xfer_blocks <= SD_DEF_XFER_BLOCKS &&
6b7e9cde
MP
3142 logical_to_bytes(sdp, sdkp->opt_xfer_blocks) >= PAGE_SIZE) {
3143 q->limits.io_opt = logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3144 rw_max = logical_to_sectors(sdp, sdkp->opt_xfer_blocks);
3145 } else
67804145
FZ
3146 rw_max = min_not_zero(logical_to_sectors(sdp, dev_max),
3147 (sector_t)BLK_DEF_MAX_SECTORS);
3a9794d3 3148
77082ca5
MP
3149 /* Do not exceed controller limit */
3150 rw_max = min(rw_max, queue_max_hw_sectors(q));
3151
3152 /*
3153 * Only update max_sectors if previously unset or if the current value
3154 * exceeds the capabilities of the hardware.
3155 */
3156 if (sdkp->first_scan ||
3157 q->limits.max_sectors > q->limits.max_dev_sectors ||
3158 q->limits.max_sectors > q->limits.max_hw_sectors)
3159 q->limits.max_sectors = rw_max;
3160
3161 sdkp->first_scan = 0;
4f258a46 3162
f08bb1e0 3163 set_capacity(disk, logical_to_sectors(sdp, sdkp->capacity));
5db44863 3164 sd_config_write_same(sdkp);
1da177e4
LT
3165 kfree(buffer);
3166
1da177e4
LT
3167 out:
3168 return 0;
3169}
3170
72ec24bd
TH
3171/**
3172 * sd_unlock_native_capacity - unlock native capacity
3173 * @disk: struct gendisk to set capacity for
3174 *
3175 * Block layer calls this function if it detects that partitions
3176 * on @disk reach beyond the end of the device. If the SCSI host
3177 * implements ->unlock_native_capacity() method, it's invoked to
3178 * give it a chance to adjust the device capacity.
3179 *
3180 * CONTEXT:
3181 * Defined by block layer. Might sleep.
3182 */
3183static void sd_unlock_native_capacity(struct gendisk *disk)
3184{
3185 struct scsi_device *sdev = scsi_disk(disk)->device;
3186
3187 if (sdev->host->hostt->unlock_native_capacity)
3188 sdev->host->hostt->unlock_native_capacity(sdev);
3189}
3190
3e1a7ff8
TH
3191/**
3192 * sd_format_disk_name - format disk name
3193 * @prefix: name prefix - ie. "sd" for SCSI disks
3194 * @index: index of the disk to format name for
3195 * @buf: output buffer
3196 * @buflen: length of the output buffer
3197 *
3198 * SCSI disk names starts at sda. The 26th device is sdz and the
3199 * 27th is sdaa. The last one for two lettered suffix is sdzz
3200 * which is followed by sdaaa.
3201 *
3202 * This is basically 26 base counting with one extra 'nil' entry
3ad2f3fb 3203 * at the beginning from the second digit on and can be
3e1a7ff8
TH
3204 * determined using similar method as 26 base conversion with the
3205 * index shifted -1 after each digit is computed.
3206 *
3207 * CONTEXT:
3208 * Don't care.
3209 *
3210 * RETURNS:
3211 * 0 on success, -errno on failure.
3212 */
3213static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
3214{
3215 const int base = 'z' - 'a' + 1;
3216 char *begin = buf + strlen(prefix);
3217 char *end = buf + buflen;
3218 char *p;
3219 int unit;
3220
3221 p = end - 1;
3222 *p = '\0';
3223 unit = base;
3224 do {
3225 if (p == begin)
3226 return -EINVAL;
3227 *--p = 'a' + (index % unit);
3228 index = (index / unit) - 1;
3229 } while (index >= 0);
3230
3231 memmove(begin, p, end - p);
3232 memcpy(buf, prefix, strlen(prefix));
3233
3234 return 0;
3235}
3236
4ace92fc
AV
3237/*
3238 * The asynchronous part of sd_probe
3239 */
3240static void sd_probe_async(void *data, async_cookie_t cookie)
3241{
3242 struct scsi_disk *sdkp = data;
3243 struct scsi_device *sdp;
3244 struct gendisk *gd;
3245 u32 index;
3246 struct device *dev;
3247
3248 sdp = sdkp->device;
3249 gd = sdkp->disk;
3250 index = sdkp->index;
3251 dev = &sdp->sdev_gendev;
3252
1a03ae0f
MR
3253 gd->major = sd_major((index & 0xf0) >> 4);
3254 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
1a03ae0f 3255
4ace92fc
AV
3256 gd->fops = &sd_fops;
3257 gd->private_data = &sdkp->driver;
3258 gd->queue = sdkp->device->request_queue;
3259
70a9b873
MP
3260 /* defaults, until the device tells us otherwise */
3261 sdp->sector_size = 512;
3262 sdkp->capacity = 0;
3263 sdkp->media_present = 1;
3264 sdkp->write_prot = 0;
39c60a09 3265 sdkp->cache_override = 0;
70a9b873
MP
3266 sdkp->WCE = 0;
3267 sdkp->RCD = 0;
3268 sdkp->ATO = 0;
3269 sdkp->first_scan = 1;
18a4d0a2 3270 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
70a9b873 3271
4ace92fc
AV
3272 sd_revalidate_disk(gd);
3273
97fedbbe 3274 gd->flags = GENHD_FL_EXT_DEVT;
2bae0093 3275 if (sdp->removable) {
4ace92fc 3276 gd->flags |= GENHD_FL_REMOVABLE;
2bae0093
TH
3277 gd->events |= DISK_EVENT_MEDIA_CHANGE;
3278 }
4ace92fc 3279
10c580e4 3280 blk_pm_runtime_init(sdp->request_queue, dev);
fef912bf 3281 device_add_disk(dev, gd, NULL);
fe542396
MP
3282 if (sdkp->capacity)
3283 sd_dif_config_host(sdkp);
4ace92fc 3284
3821d768
MP
3285 sd_revalidate_disk(gd);
3286
d80210f2
CH
3287 if (sdkp->security) {
3288 sdkp->opal_dev = init_opal_dev(sdp, &sd_sec_submit);
3289 if (sdkp->opal_dev)
3290 sd_printk(KERN_NOTICE, sdkp, "supports TCG Opal\n");
3291 }
3292
4ace92fc
AV
3293 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
3294 sdp->removable ? "removable " : "");
478a8a05 3295 scsi_autopm_put_device(sdp);
ea038f63 3296 put_device(&sdkp->dev);
4ace92fc
AV
3297}
3298
1da177e4
LT
3299/**
3300 * sd_probe - called during driver initialization and whenever a
3301 * new scsi device is attached to the system. It is called once
3302 * for each scsi device (not just disks) present.
3303 * @dev: pointer to device object
3304 *
3305 * Returns 0 if successful (or not interested in this scsi device
3306 * (e.g. scanner)); 1 when there is an error.
3307 *
3308 * Note: this function is invoked from the scsi mid-level.
3309 * This function sets up the mapping between a given
3310 * <host,channel,id,lun> (found in sdp) and new device name
3311 * (e.g. /dev/sda). More precisely it is the block device major
3312 * and minor number that is chosen here.
3313 *
2db93ce8
PU
3314 * Assume sd_probe is not re-entrant (for time being)
3315 * Also think about sd_probe() and sd_remove() running coincidentally.
1da177e4
LT
3316 **/
3317static int sd_probe(struct device *dev)
3318{
3319 struct scsi_device *sdp = to_scsi_device(dev);
3320 struct scsi_disk *sdkp;
3321 struct gendisk *gd;
439d77f7 3322 int index;
1da177e4
LT
3323 int error;
3324
6fe8c1db 3325 scsi_autopm_get_device(sdp);
1da177e4 3326 error = -ENODEV;
89d94756
HR
3327 if (sdp->type != TYPE_DISK &&
3328 sdp->type != TYPE_ZBC &&
3329 sdp->type != TYPE_MOD &&
3330 sdp->type != TYPE_RBC)
1da177e4
LT
3331 goto out;
3332
89d94756
HR
3333#ifndef CONFIG_BLK_DEV_ZONED
3334 if (sdp->type == TYPE_ZBC)
3335 goto out;
3336#endif
9ccfc756 3337 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
2db93ce8 3338 "sd_probe\n"));
1da177e4
LT
3339
3340 error = -ENOMEM;
24669f75 3341 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
1da177e4
LT
3342 if (!sdkp)
3343 goto out;
3344
689d6fac 3345 gd = alloc_disk(SD_MINORS);
1da177e4 3346 if (!gd)
c01228db 3347 goto out_free;
1da177e4 3348
94015080
MW
3349 index = ida_alloc(&sd_index_ida, GFP_KERNEL);
3350 if (index < 0) {
21208ae5 3351 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
1da177e4 3352 goto out_put;
1a03ae0f
MR
3353 }
3354
3e1a7ff8 3355 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
21208ae5
DK
3356 if (error) {
3357 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
f27bac27 3358 goto out_free_index;
21208ae5 3359 }
f27bac27 3360
1da177e4
LT
3361 sdkp->device = sdp;
3362 sdkp->driver = &sd_template;
3363 sdkp->disk = gd;
3364 sdkp->index = index;
409f3499 3365 atomic_set(&sdkp->openers, 0);
9e1a1537 3366 atomic_set(&sdkp->device->ioerr_cnt, 0);
1da177e4 3367
601e7638
JB
3368 if (!sdp->request_queue->rq_timeout) {
3369 if (sdp->type != TYPE_MOD)
3370 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
3371 else
3372 blk_queue_rq_timeout(sdp->request_queue,
3373 SD_MOD_TIMEOUT);
3374 }
3375
3376 device_initialize(&sdkp->dev);
478a8a05 3377 sdkp->dev.parent = dev;
601e7638 3378 sdkp->dev.class = &sd_disk_class;
02aa2a37 3379 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
601e7638 3380
dee0586e
DC
3381 error = device_add(&sdkp->dev);
3382 if (error)
601e7638
JB
3383 goto out_free_index;
3384
478a8a05
AS
3385 get_device(dev);
3386 dev_set_drvdata(dev, sdkp);
601e7638 3387
ea038f63 3388 get_device(&sdkp->dev); /* prevent release before async_schedule */
a7a20d10 3389 async_schedule_domain(sd_probe_async, sdkp, &scsi_sd_probe_domain);
1da177e4
LT
3390
3391 return 0;
3392
f27bac27 3393 out_free_index:
94015080 3394 ida_free(&sd_index_ida, index);
6bdaa1f1 3395 out_put:
1da177e4 3396 put_disk(gd);
f170396c
CIK
3397 out_free:
3398 kfree(sdkp);
6bdaa1f1 3399 out:
6fe8c1db 3400 scsi_autopm_put_device(sdp);
1da177e4
LT
3401 return error;
3402}
3403
3404/**
3405 * sd_remove - called whenever a scsi disk (previously recognized by
3406 * sd_probe) is detached from the system. It is called (potentially
3407 * multiple times) during sd module unload.
f2a3313d 3408 * @dev: pointer to device object
1da177e4
LT
3409 *
3410 * Note: this function is invoked from the scsi mid-level.
3411 * This function potentially frees up a device name (e.g. /dev/sdc)
3412 * that could be re-used by a subsequent sd_probe().
3413 * This function is not called when the built-in sd driver is "exit-ed".
3414 **/
3415static int sd_remove(struct device *dev)
3416{
601e7638 3417 struct scsi_disk *sdkp;
0761df9c 3418 dev_t devt;
1da177e4 3419
601e7638 3420 sdkp = dev_get_drvdata(dev);
0761df9c 3421 devt = disk_devt(sdkp->disk);
478a8a05
AS
3422 scsi_autopm_get_device(sdkp->device);
3423
3c31b52f 3424 async_synchronize_full_domain(&scsi_sd_pm_domain);
a7a20d10 3425 async_synchronize_full_domain(&scsi_sd_probe_domain);
ee959b00 3426 device_del(&sdkp->dev);
1da177e4
LT
3427 del_gendisk(sdkp->disk);
3428 sd_shutdown(dev);
39b7f1e2 3429
d80210f2
CH
3430 free_opal_dev(sdkp->opal_dev);
3431
0761df9c
HR
3432 blk_register_region(devt, SD_MINORS, NULL,
3433 sd_default_probe, NULL, NULL);
3434
0b950672 3435 mutex_lock(&sd_ref_mutex);
39b7f1e2 3436 dev_set_drvdata(dev, NULL);
ee959b00 3437 put_device(&sdkp->dev);
0b950672 3438 mutex_unlock(&sd_ref_mutex);
1da177e4
LT
3439
3440 return 0;
3441}
3442
3443/**
3444 * scsi_disk_release - Called to free the scsi_disk structure
ee959b00 3445 * @dev: pointer to embedded class device
1da177e4 3446 *
0b950672 3447 * sd_ref_mutex must be held entering this routine. Because it is
1da177e4
LT
3448 * called on last put, you should always use the scsi_disk_get()
3449 * scsi_disk_put() helpers which manipulate the semaphore directly
ee959b00 3450 * and never do a direct put_device.
1da177e4 3451 **/
ee959b00 3452static void scsi_disk_release(struct device *dev)
1da177e4 3453{
ee959b00 3454 struct scsi_disk *sdkp = to_scsi_disk(dev);
1da177e4
LT
3455 struct gendisk *disk = sdkp->disk;
3456
94015080 3457 ida_free(&sd_index_ida, sdkp->index);
c01228db 3458
1da177e4 3459 disk->private_data = NULL;
1da177e4 3460 put_disk(disk);
39b7f1e2 3461 put_device(&sdkp->device->sdev_gendev);
1da177e4
LT
3462
3463 kfree(sdkp);
3464}
3465
cc5d2c8c 3466static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
c3c94c5a
TH
3467{
3468 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3469 struct scsi_sense_hdr sshdr;
cc5d2c8c 3470 struct scsi_device *sdp = sdkp->device;
c3c94c5a
TH
3471 int res;
3472
3473 if (start)
3474 cmd[4] |= 1; /* START */
3475
d2886ea3
SR
3476 if (sdp->start_stop_pwr_cond)
3477 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3478
c3c94c5a
TH
3479 if (!scsi_device_online(sdp))
3480 return -ENODEV;
3481
fcbfffe2
CH
3482 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, &sshdr,
3483 SD_TIMEOUT, SD_MAX_RETRIES, 0, RQF_PM, NULL);
c3c94c5a 3484 if (res) {
ef61329d 3485 sd_print_result(sdkp, "Start/Stop Unit failed", res);
c65be1a6 3486 if (driver_byte(res) == DRIVER_SENSE)
cc5d2c8c 3487 sd_print_sense_hdr(sdkp, &sshdr);
95897910
ON
3488 if (scsi_sense_valid(&sshdr) &&
3489 /* 0x3a is medium not present */
3490 sshdr.asc == 0x3a)
3491 res = 0;
c3c94c5a
TH
3492 }
3493
95897910
ON
3494 /* SCSI error codes must not go to the generic layer */
3495 if (res)
3496 return -EIO;
3497
3498 return 0;
c3c94c5a
TH
3499}
3500
1da177e4
LT
3501/*
3502 * Send a SYNCHRONIZE CACHE instruction down to the device through
3503 * the normal SCSI command structure. Wait for the command to
3504 * complete.
3505 */
3506static void sd_shutdown(struct device *dev)
3507{
3d9a1f53 3508 struct scsi_disk *sdkp = dev_get_drvdata(dev);
1da177e4
LT
3509
3510 if (!sdkp)
3511 return; /* this can happen */
3512
54f57588 3513 if (pm_runtime_suspended(dev))
3d9a1f53 3514 return;
54f57588 3515
95897910 3516 if (sdkp->WCE && sdkp->media_present) {
e73aec82 3517 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
4fa83244 3518 sd_sync_cache(sdkp, NULL);
39b7f1e2 3519 }
c3c94c5a 3520
cc5d2c8c
JB
3521 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3522 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3523 sd_start_stop_device(sdkp, 0);
c3c94c5a 3524 }
39b7f1e2 3525}
1da177e4 3526
95897910 3527static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
c3c94c5a 3528{
3d9a1f53 3529 struct scsi_disk *sdkp = dev_get_drvdata(dev);
4fa83244 3530 struct scsi_sense_hdr sshdr;
09ff92fe 3531 int ret = 0;
c3c94c5a 3532
13b43891
AS
3533 if (!sdkp) /* E.g.: runtime suspend following sd_remove() */
3534 return 0;
c3c94c5a 3535
95897910 3536 if (sdkp->WCE && sdkp->media_present) {
cc5d2c8c 3537 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
4fa83244
DB
3538 ret = sd_sync_cache(sdkp, &sshdr);
3539
95897910
ON
3540 if (ret) {
3541 /* ignore OFFLINE device */
3542 if (ret == -ENODEV)
4fa83244
DB
3543 return 0;
3544
3545 if (!scsi_sense_valid(&sshdr) ||
3546 sshdr.sense_key != ILLEGAL_REQUEST)
3547 return ret;
3548
3549 /*
3550 * sshdr.sense_key == ILLEGAL_REQUEST means this drive
3551 * doesn't support sync. There's not much to do and
3552 * suspend shouldn't fail.
3553 */
ed91f7ed 3554 ret = 0;
95897910 3555 }
c3c94c5a
TH
3556 }
3557
691e3d31 3558 if (sdkp->device->manage_start_stop) {
cc5d2c8c 3559 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
95897910 3560 /* an error is not worth aborting a system sleep */
cc5d2c8c 3561 ret = sd_start_stop_device(sdkp, 0);
95897910
ON
3562 if (ignore_stop_errors)
3563 ret = 0;
c3c94c5a
TH
3564 }
3565
09ff92fe 3566 return ret;
c3c94c5a
TH
3567}
3568
95897910
ON
3569static int sd_suspend_system(struct device *dev)
3570{
3571 return sd_suspend_common(dev, true);
3572}
3573
3574static int sd_suspend_runtime(struct device *dev)
3575{
3576 return sd_suspend_common(dev, false);
3577}
3578
c3c94c5a
TH
3579static int sd_resume(struct device *dev)
3580{
3d9a1f53 3581 struct scsi_disk *sdkp = dev_get_drvdata(dev);
d80210f2 3582 int ret;
c3c94c5a 3583
13b43891
AS
3584 if (!sdkp) /* E.g.: runtime resume at the start of sd_probe() */
3585 return 0;
3586
cc5d2c8c 3587 if (!sdkp->device->manage_start_stop)
3d9a1f53 3588 return 0;
c3c94c5a 3589
cc5d2c8c 3590 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
d80210f2
CH
3591 ret = sd_start_stop_device(sdkp, 1);
3592 if (!ret)
3593 opal_unlock_from_suspend(sdkp->opal_dev);
3594 return ret;
c3c94c5a
TH
3595}
3596
1da177e4
LT
3597/**
3598 * init_sd - entry point for this driver (both when built in or when
3599 * a module).
3600 *
3601 * Note: this function registers this driver with the scsi mid-level.
3602 **/
3603static int __init init_sd(void)
3604{
5e4009ba 3605 int majors = 0, i, err;
1da177e4
LT
3606
3607 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3608
0761df9c
HR
3609 for (i = 0; i < SD_MAJORS; i++) {
3610 if (register_blkdev(sd_major(i), "sd") != 0)
3611 continue;
3612 majors++;
3613 blk_register_region(sd_major(i), SD_MINORS, NULL,
3614 sd_default_probe, NULL, NULL);
3615 }
1da177e4
LT
3616
3617 if (!majors)
3618 return -ENODEV;
3619
5e4009ba
JG
3620 err = class_register(&sd_disk_class);
3621 if (err)
3622 goto err_out;
6bdaa1f1 3623
4e7392ec
MP
3624 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3625 0, 0, NULL);
3626 if (!sd_cdb_cache) {
3627 printk(KERN_ERR "sd: can't init extended cdb cache\n");
8d964478 3628 err = -ENOMEM;
4e7392ec
MP
3629 goto err_out_class;
3630 }
3631
3632 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3633 if (!sd_cdb_pool) {
3634 printk(KERN_ERR "sd: can't init extended cdb pool\n");
8d964478 3635 err = -ENOMEM;
4e7392ec
MP
3636 goto err_out_cache;
3637 }
3638
61cce6f6
JA
3639 sd_page_pool = mempool_create_page_pool(SD_MEMPOOL_SIZE, 0);
3640 if (!sd_page_pool) {
3641 printk(KERN_ERR "sd: can't init discard page pool\n");
3642 err = -ENOMEM;
3643 goto err_out_ppool;
3644 }
3645
afd5e34b
JD
3646 err = scsi_register_driver(&sd_template.gendrv);
3647 if (err)
3648 goto err_out_driver;
3649
5e4009ba
JG
3650 return 0;
3651
afd5e34b 3652err_out_driver:
61cce6f6
JA
3653 mempool_destroy(sd_page_pool);
3654
3655err_out_ppool:
afd5e34b
JD
3656 mempool_destroy(sd_cdb_pool);
3657
4e7392ec
MP
3658err_out_cache:
3659 kmem_cache_destroy(sd_cdb_cache);
3660
5e4009ba
JG
3661err_out_class:
3662 class_unregister(&sd_disk_class);
3663err_out:
3664 for (i = 0; i < SD_MAJORS; i++)
3665 unregister_blkdev(sd_major(i), "sd");
3666 return err;
1da177e4
LT
3667}
3668
3669/**
3670 * exit_sd - exit point for this driver (when it is a module).
3671 *
3672 * Note: this function unregisters this driver from the scsi mid-level.
3673 **/
3674static void __exit exit_sd(void)
3675{
3676 int i;
3677
3678 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3679
afd5e34b 3680 scsi_unregister_driver(&sd_template.gendrv);
4e7392ec 3681 mempool_destroy(sd_cdb_pool);
61cce6f6 3682 mempool_destroy(sd_page_pool);
4e7392ec
MP
3683 kmem_cache_destroy(sd_cdb_cache);
3684
5e4009ba
JG
3685 class_unregister(&sd_disk_class);
3686
0761df9c
HR
3687 for (i = 0; i < SD_MAJORS; i++) {
3688 blk_unregister_region(sd_major(i), SD_MINORS);
1da177e4 3689 unregister_blkdev(sd_major(i), "sd");
0761df9c 3690 }
1da177e4
LT
3691}
3692
1da177e4
LT
3693module_init(init_sd);
3694module_exit(exit_sd);
e73aec82
MP
3695
3696static void sd_print_sense_hdr(struct scsi_disk *sdkp,
3697 struct scsi_sense_hdr *sshdr)
3698{
21045519
HR
3699 scsi_print_sense_hdr(sdkp->device,
3700 sdkp->disk ? sdkp->disk->disk_name : NULL, sshdr);
e73aec82
MP
3701}
3702
ef61329d
HR
3703static void sd_print_result(const struct scsi_disk *sdkp, const char *msg,
3704 int result)
e73aec82 3705{
ef61329d
HR
3706 const char *hb_string = scsi_hostbyte_string(result);
3707 const char *db_string = scsi_driverbyte_string(result);
3708
3709 if (hb_string || db_string)
3710 sd_printk(KERN_INFO, sdkp,
3711 "%s: Result: hostbyte=%s driverbyte=%s\n", msg,
3712 hb_string ? hb_string : "invalid",
3713 db_string ? db_string : "invalid");
3714 else
3715 sd_printk(KERN_INFO, sdkp,
3716 "%s: Result: hostbyte=0x%02x driverbyte=0x%02x\n",
3717 msg, host_byte(result), driver_byte(result));
e73aec82
MP
3718}
3719