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