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