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