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