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