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