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