[SCSI] drivers/scsi: Use ARRAY_SIZE macro
[linux-3.10.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/config.h>
36 #include <linux/module.h>
37 #include <linux/fs.h>
38 #include <linux/kernel.h>
39 #include <linux/sched.h>
40 #include <linux/mm.h>
41 #include <linux/bio.h>
42 #include <linux/genhd.h>
43 #include <linux/hdreg.h>
44 #include <linux/errno.h>
45 #include <linux/idr.h>
46 #include <linux/interrupt.h>
47 #include <linux/init.h>
48 #include <linux/blkdev.h>
49 #include <linux/blkpg.h>
50 #include <linux/delay.h>
51 #include <linux/mutex.h>
52 #include <asm/uaccess.h>
53
54 #include <scsi/scsi.h>
55 #include <scsi/scsi_cmnd.h>
56 #include <scsi/scsi_dbg.h>
57 #include <scsi/scsi_device.h>
58 #include <scsi/scsi_driver.h>
59 #include <scsi/scsi_eh.h>
60 #include <scsi/scsi_host.h>
61 #include <scsi/scsi_ioctl.h>
62 #include <scsi/scsicam.h>
63
64 #include "scsi_logging.h"
65
66 /*
67  * More than enough for everybody ;)  The huge number of majors
68  * is a leftover from 16bit dev_t days, we don't really need that
69  * much numberspace.
70  */
71 #define SD_MAJORS       16
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
94 /*
95  * This is limited by the naming scheme enforced in sd_probe,
96  * add another character to it if you really need more disks.
97  */
98 #define SD_MAX_DISKS    (((26 * 26) + 26 + 1) * 26)
99
100 /*
101  * Time out in seconds for disks and Magneto-opticals (which are slower).
102  */
103 #define SD_TIMEOUT              (30 * HZ)
104 #define SD_MOD_TIMEOUT          (75 * HZ)
105
106 /*
107  * Number of allowed retries
108  */
109 #define SD_MAX_RETRIES          5
110 #define SD_PASSTHROUGH_RETRIES  1
111
112 /*
113  * Size of the initial data buffer for mode and read capacity data
114  */
115 #define SD_BUF_SIZE             512
116
117 struct scsi_disk {
118         struct scsi_driver *driver;     /* always &sd_template */
119         struct scsi_device *device;
120         struct class_device cdev;
121         struct gendisk  *disk;
122         unsigned int    openers;        /* protected by BKL for now, yuck */
123         sector_t        capacity;       /* size in 512-byte sectors */
124         u32             index;
125         u8              media_present;
126         u8              write_prot;
127         unsigned        WCE : 1;        /* state of disk WCE bit */
128         unsigned        RCD : 1;        /* state of disk RCD bit, unused */
129         unsigned        DPOFUA : 1;     /* state of disk DPOFUA bit */
130 };
131 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,cdev)
132
133 static DEFINE_IDR(sd_index_idr);
134 static DEFINE_SPINLOCK(sd_index_lock);
135
136 /* This semaphore is used to mediate the 0->1 reference get in the
137  * face of object destruction (i.e. we can't allow a get on an
138  * object after last put) */
139 static DEFINE_MUTEX(sd_ref_mutex);
140
141 static int sd_revalidate_disk(struct gendisk *disk);
142 static void sd_rw_intr(struct scsi_cmnd * SCpnt);
143
144 static int sd_probe(struct device *);
145 static int sd_remove(struct device *);
146 static void sd_shutdown(struct device *dev);
147 static void sd_rescan(struct device *);
148 static int sd_init_command(struct scsi_cmnd *);
149 static int sd_issue_flush(struct device *, sector_t *);
150 static void sd_prepare_flush(request_queue_t *, struct request *);
151 static void sd_read_capacity(struct scsi_disk *sdkp, char *diskname,
152                              unsigned char *buffer);
153 static void scsi_disk_release(struct class_device *cdev);
154
155 static const char *sd_cache_types[] = {
156         "write through", "none", "write back",
157         "write back, no read (daft)"
158 };
159
160 static ssize_t sd_store_cache_type(struct class_device *cdev, const char *buf,
161                                    size_t count)
162 {
163         int i, ct = -1, rcd, wce, sp;
164         struct scsi_disk *sdkp = to_scsi_disk(cdev);
165         struct scsi_device *sdp = sdkp->device;
166         char buffer[64];
167         char *buffer_data;
168         struct scsi_mode_data data;
169         struct scsi_sense_hdr sshdr;
170         int len;
171
172         if (sdp->type != TYPE_DISK)
173                 /* no cache control on RBC devices; theoretically they
174                  * can do it, but there's probably so many exceptions
175                  * it's not worth the risk */
176                 return -EINVAL;
177
178         for (i = 0; i < ARRAY_SIZE(sd_cache_types); i++) {
179                 const int len = strlen(sd_cache_types[i]);
180                 if (strncmp(sd_cache_types[i], buf, len) == 0 &&
181                     buf[len] == '\n') {
182                         ct = i;
183                         break;
184                 }
185         }
186         if (ct < 0)
187                 return -EINVAL;
188         rcd = ct & 0x01 ? 1 : 0;
189         wce = ct & 0x02 ? 1 : 0;
190         if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
191                             SD_MAX_RETRIES, &data, NULL))
192                 return -EINVAL;
193         len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
194                   data.block_descriptor_length);
195         buffer_data = buffer + data.header_length +
196                 data.block_descriptor_length;
197         buffer_data[2] &= ~0x05;
198         buffer_data[2] |= wce << 2 | rcd;
199         sp = buffer_data[0] & 0x80 ? 1 : 0;
200
201         if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
202                              SD_MAX_RETRIES, &data, &sshdr)) {
203                 if (scsi_sense_valid(&sshdr))
204                         scsi_print_sense_hdr(sdkp->disk->disk_name, &sshdr);
205                 return -EINVAL;
206         }
207         sd_revalidate_disk(sdkp->disk);
208         return count;
209 }
210
211 static ssize_t sd_show_cache_type(struct class_device *cdev, char *buf)
212 {
213         struct scsi_disk *sdkp = to_scsi_disk(cdev);
214         int ct = sdkp->RCD + 2*sdkp->WCE;
215
216         return snprintf(buf, 40, "%s\n", sd_cache_types[ct]);
217 }
218
219 static ssize_t sd_show_fua(struct class_device *cdev, char *buf)
220 {
221         struct scsi_disk *sdkp = to_scsi_disk(cdev);
222
223         return snprintf(buf, 20, "%u\n", sdkp->DPOFUA);
224 }
225
226 static struct class_device_attribute sd_disk_attrs[] = {
227         __ATTR(cache_type, S_IRUGO|S_IWUSR, sd_show_cache_type,
228                sd_store_cache_type),
229         __ATTR(FUA, S_IRUGO, sd_show_fua, NULL),
230         __ATTR_NULL,
231 };
232
233 static struct class sd_disk_class = {
234         .name           = "scsi_disk",
235         .owner          = THIS_MODULE,
236         .release        = scsi_disk_release,
237         .class_dev_attrs = sd_disk_attrs,
238 };
239
240 static struct scsi_driver sd_template = {
241         .owner                  = THIS_MODULE,
242         .gendrv = {
243                 .name           = "sd",
244                 .probe          = sd_probe,
245                 .remove         = sd_remove,
246                 .shutdown       = sd_shutdown,
247         },
248         .rescan                 = sd_rescan,
249         .init_command           = sd_init_command,
250         .issue_flush            = sd_issue_flush,
251 };
252
253 /*
254  * Device no to disk mapping:
255  * 
256  *       major         disc2     disc  p1
257  *   |............|.............|....|....| <- dev_t
258  *    31        20 19          8 7  4 3  0
259  * 
260  * Inside a major, we have 16k disks, however mapped non-
261  * contiguously. The first 16 disks are for major0, the next
262  * ones with major1, ... Disk 256 is for major0 again, disk 272 
263  * for major1, ... 
264  * As we stay compatible with our numbering scheme, we can reuse 
265  * the well-know SCSI majors 8, 65--71, 136--143.
266  */
267 static int sd_major(int major_idx)
268 {
269         switch (major_idx) {
270         case 0:
271                 return SCSI_DISK0_MAJOR;
272         case 1 ... 7:
273                 return SCSI_DISK1_MAJOR + major_idx - 1;
274         case 8 ... 15:
275                 return SCSI_DISK8_MAJOR + major_idx - 8;
276         default:
277                 BUG();
278                 return 0;       /* shut up gcc */
279         }
280 }
281
282 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
283 {
284         return container_of(disk->private_data, struct scsi_disk, driver);
285 }
286
287 static struct scsi_disk *__scsi_disk_get(struct gendisk *disk)
288 {
289         struct scsi_disk *sdkp = NULL;
290
291         if (disk->private_data) {
292                 sdkp = scsi_disk(disk);
293                 if (scsi_device_get(sdkp->device) == 0)
294                         class_device_get(&sdkp->cdev);
295                 else
296                         sdkp = NULL;
297         }
298         return sdkp;
299 }
300
301 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
302 {
303         struct scsi_disk *sdkp;
304
305         mutex_lock(&sd_ref_mutex);
306         sdkp = __scsi_disk_get(disk);
307         mutex_unlock(&sd_ref_mutex);
308         return sdkp;
309 }
310
311 static struct scsi_disk *scsi_disk_get_from_dev(struct device *dev)
312 {
313         struct scsi_disk *sdkp;
314
315         mutex_lock(&sd_ref_mutex);
316         sdkp = dev_get_drvdata(dev);
317         if (sdkp)
318                 sdkp = __scsi_disk_get(sdkp->disk);
319         mutex_unlock(&sd_ref_mutex);
320         return sdkp;
321 }
322
323 static void scsi_disk_put(struct scsi_disk *sdkp)
324 {
325         struct scsi_device *sdev = sdkp->device;
326
327         mutex_lock(&sd_ref_mutex);
328         class_device_put(&sdkp->cdev);
329         scsi_device_put(sdev);
330         mutex_unlock(&sd_ref_mutex);
331 }
332
333 /**
334  *      sd_init_command - build a scsi (read or write) command from
335  *      information in the request structure.
336  *      @SCpnt: pointer to mid-level's per scsi command structure that
337  *      contains request and into which the scsi command is written
338  *
339  *      Returns 1 if successful and 0 if error (or cannot be done now).
340  **/
341 static int sd_init_command(struct scsi_cmnd * SCpnt)
342 {
343         struct scsi_device *sdp = SCpnt->device;
344         struct request *rq = SCpnt->request;
345         struct gendisk *disk = rq->rq_disk;
346         sector_t block = rq->sector;
347         unsigned int this_count = SCpnt->request_bufflen >> 9;
348         unsigned int timeout = sdp->timeout;
349
350         SCSI_LOG_HLQUEUE(1, printk("sd_init_command: disk=%s, block=%llu, "
351                             "count=%d\n", disk->disk_name,
352                          (unsigned long long)block, this_count));
353
354         if (!sdp || !scsi_device_online(sdp) ||
355             block + rq->nr_sectors > get_capacity(disk)) {
356                 SCSI_LOG_HLQUEUE(2, printk("Finishing %ld sectors\n", 
357                                  rq->nr_sectors));
358                 SCSI_LOG_HLQUEUE(2, printk("Retry with 0x%p\n", SCpnt));
359                 return 0;
360         }
361
362         if (sdp->changed) {
363                 /*
364                  * quietly refuse to do anything to a changed disc until 
365                  * the changed bit has been reset
366                  */
367                 /* printk("SCSI disk has been changed. Prohibiting further I/O.\n"); */
368                 return 0;
369         }
370         SCSI_LOG_HLQUEUE(2, printk("%s : block=%llu\n",
371                                    disk->disk_name, (unsigned long long)block));
372
373         /*
374          * If we have a 1K hardware sectorsize, prevent access to single
375          * 512 byte sectors.  In theory we could handle this - in fact
376          * the scsi cdrom driver must be able to handle this because
377          * we typically use 1K blocksizes, and cdroms typically have
378          * 2K hardware sectorsizes.  Of course, things are simpler
379          * with the cdrom, since it is read-only.  For performance
380          * reasons, the filesystems should be able to handle this
381          * and not force the scsi disk driver to use bounce buffers
382          * for this.
383          */
384         if (sdp->sector_size == 1024) {
385                 if ((block & 1) || (rq->nr_sectors & 1)) {
386                         printk(KERN_ERR "sd: Bad block number requested");
387                         return 0;
388                 } else {
389                         block = block >> 1;
390                         this_count = this_count >> 1;
391                 }
392         }
393         if (sdp->sector_size == 2048) {
394                 if ((block & 3) || (rq->nr_sectors & 3)) {
395                         printk(KERN_ERR "sd: Bad block number requested");
396                         return 0;
397                 } else {
398                         block = block >> 2;
399                         this_count = this_count >> 2;
400                 }
401         }
402         if (sdp->sector_size == 4096) {
403                 if ((block & 7) || (rq->nr_sectors & 7)) {
404                         printk(KERN_ERR "sd: Bad block number requested");
405                         return 0;
406                 } else {
407                         block = block >> 3;
408                         this_count = this_count >> 3;
409                 }
410         }
411         if (rq_data_dir(rq) == WRITE) {
412                 if (!sdp->writeable) {
413                         return 0;
414                 }
415                 SCpnt->cmnd[0] = WRITE_6;
416                 SCpnt->sc_data_direction = DMA_TO_DEVICE;
417         } else if (rq_data_dir(rq) == READ) {
418                 SCpnt->cmnd[0] = READ_6;
419                 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
420         } else {
421                 printk(KERN_ERR "sd: Unknown command %lx\n", rq->flags);
422 /* overkill     panic("Unknown sd command %lx\n", rq->flags); */
423                 return 0;
424         }
425
426         SCSI_LOG_HLQUEUE(2, printk("%s : %s %d/%ld 512 byte blocks.\n", 
427                 disk->disk_name, (rq_data_dir(rq) == WRITE) ? 
428                 "writing" : "reading", this_count, rq->nr_sectors));
429
430         SCpnt->cmnd[1] = 0;
431         
432         if (block > 0xffffffff) {
433                 SCpnt->cmnd[0] += READ_16 - READ_6;
434                 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
435                 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
436                 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
437                 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
438                 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
439                 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
440                 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
441                 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
442                 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
443                 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
444                 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
445                 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
446                 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
447                 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
448         } else if ((this_count > 0xff) || (block > 0x1fffff) ||
449                    SCpnt->device->use_10_for_rw) {
450                 if (this_count > 0xffff)
451                         this_count = 0xffff;
452
453                 SCpnt->cmnd[0] += READ_10 - READ_6;
454                 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
455                 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
456                 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
457                 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
458                 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
459                 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
460                 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
461                 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
462         } else {
463                 if (unlikely(blk_fua_rq(rq))) {
464                         /*
465                          * This happens only if this drive failed
466                          * 10byte rw command with ILLEGAL_REQUEST
467                          * during operation and thus turned off
468                          * use_10_for_rw.
469                          */
470                         printk(KERN_ERR "sd: FUA write on READ/WRITE(6) drive\n");
471                         return 0;
472                 }
473
474                 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
475                 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
476                 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
477                 SCpnt->cmnd[4] = (unsigned char) this_count;
478                 SCpnt->cmnd[5] = 0;
479         }
480         SCpnt->request_bufflen = SCpnt->bufflen =
481                         this_count * sdp->sector_size;
482
483         /*
484          * We shouldn't disconnect in the middle of a sector, so with a dumb
485          * host adapter, it's safe to assume that we can at least transfer
486          * this many bytes between each connect / disconnect.
487          */
488         SCpnt->transfersize = sdp->sector_size;
489         SCpnt->underflow = this_count << 9;
490         SCpnt->allowed = SD_MAX_RETRIES;
491         SCpnt->timeout_per_command = timeout;
492
493         /*
494          * This is the completion routine we use.  This is matched in terms
495          * of capability to this function.
496          */
497         SCpnt->done = sd_rw_intr;
498
499         /*
500          * This indicates that the command is ready from our end to be
501          * queued.
502          */
503         return 1;
504 }
505
506 /**
507  *      sd_open - open a scsi disk device
508  *      @inode: only i_rdev member may be used
509  *      @filp: only f_mode and f_flags may be used
510  *
511  *      Returns 0 if successful. Returns a negated errno value in case 
512  *      of error.
513  *
514  *      Note: This can be called from a user context (e.g. fsck(1) )
515  *      or from within the kernel (e.g. as a result of a mount(1) ).
516  *      In the latter case @inode and @filp carry an abridged amount
517  *      of information as noted above.
518  **/
519 static int sd_open(struct inode *inode, struct file *filp)
520 {
521         struct gendisk *disk = inode->i_bdev->bd_disk;
522         struct scsi_disk *sdkp;
523         struct scsi_device *sdev;
524         int retval;
525
526         if (!(sdkp = scsi_disk_get(disk)))
527                 return -ENXIO;
528
529
530         SCSI_LOG_HLQUEUE(3, printk("sd_open: disk=%s\n", disk->disk_name));
531
532         sdev = sdkp->device;
533
534         /*
535          * If the device is in error recovery, wait until it is done.
536          * If the device is offline, then disallow any access to it.
537          */
538         retval = -ENXIO;
539         if (!scsi_block_when_processing_errors(sdev))
540                 goto error_out;
541
542         if (sdev->removable || sdkp->write_prot)
543                 check_disk_change(inode->i_bdev);
544
545         /*
546          * If the drive is empty, just let the open fail.
547          */
548         retval = -ENOMEDIUM;
549         if (sdev->removable && !sdkp->media_present &&
550             !(filp->f_flags & O_NDELAY))
551                 goto error_out;
552
553         /*
554          * If the device has the write protect tab set, have the open fail
555          * if the user expects to be able to write to the thing.
556          */
557         retval = -EROFS;
558         if (sdkp->write_prot && (filp->f_mode & FMODE_WRITE))
559                 goto error_out;
560
561         /*
562          * It is possible that the disk changing stuff resulted in
563          * the device being taken offline.  If this is the case,
564          * report this to the user, and don't pretend that the
565          * open actually succeeded.
566          */
567         retval = -ENXIO;
568         if (!scsi_device_online(sdev))
569                 goto error_out;
570
571         if (!sdkp->openers++ && sdev->removable) {
572                 if (scsi_block_when_processing_errors(sdev))
573                         scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
574         }
575
576         return 0;
577
578 error_out:
579         scsi_disk_put(sdkp);
580         return retval;  
581 }
582
583 /**
584  *      sd_release - invoked when the (last) close(2) is called on this
585  *      scsi disk.
586  *      @inode: only i_rdev member may be used
587  *      @filp: only f_mode and f_flags may be used
588  *
589  *      Returns 0. 
590  *
591  *      Note: may block (uninterruptible) if error recovery is underway
592  *      on this disk.
593  **/
594 static int sd_release(struct inode *inode, struct file *filp)
595 {
596         struct gendisk *disk = inode->i_bdev->bd_disk;
597         struct scsi_disk *sdkp = scsi_disk(disk);
598         struct scsi_device *sdev = sdkp->device;
599
600         SCSI_LOG_HLQUEUE(3, printk("sd_release: disk=%s\n", disk->disk_name));
601
602         if (!--sdkp->openers && sdev->removable) {
603                 if (scsi_block_when_processing_errors(sdev))
604                         scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
605         }
606
607         /*
608          * XXX and what if there are packets in flight and this close()
609          * XXX is followed by a "rmmod sd_mod"?
610          */
611         scsi_disk_put(sdkp);
612         return 0;
613 }
614
615 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
616 {
617         struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
618         struct scsi_device *sdp = sdkp->device;
619         struct Scsi_Host *host = sdp->host;
620         int diskinfo[4];
621
622         /* default to most commonly used values */
623         diskinfo[0] = 0x40;     /* 1 << 6 */
624         diskinfo[1] = 0x20;     /* 1 << 5 */
625         diskinfo[2] = sdkp->capacity >> 11;
626         
627         /* override with calculated, extended default, or driver values */
628         if (host->hostt->bios_param)
629                 host->hostt->bios_param(sdp, bdev, sdkp->capacity, diskinfo);
630         else
631                 scsicam_bios_param(bdev, sdkp->capacity, diskinfo);
632
633         geo->heads = diskinfo[0];
634         geo->sectors = diskinfo[1];
635         geo->cylinders = diskinfo[2];
636         return 0;
637 }
638
639 /**
640  *      sd_ioctl - process an ioctl
641  *      @inode: only i_rdev/i_bdev members may be used
642  *      @filp: only f_mode and f_flags may be used
643  *      @cmd: ioctl command number
644  *      @arg: this is third argument given to ioctl(2) system call.
645  *      Often contains a pointer.
646  *
647  *      Returns 0 if successful (some ioctls return postive numbers on
648  *      success as well). Returns a negated errno value in case of error.
649  *
650  *      Note: most ioctls are forward onto the block subsystem or further
651  *      down in the scsi subsytem.
652  **/
653 static int sd_ioctl(struct inode * inode, struct file * filp, 
654                     unsigned int cmd, unsigned long arg)
655 {
656         struct block_device *bdev = inode->i_bdev;
657         struct gendisk *disk = bdev->bd_disk;
658         struct scsi_device *sdp = scsi_disk(disk)->device;
659         void __user *p = (void __user *)arg;
660         int error;
661     
662         SCSI_LOG_IOCTL(1, printk("sd_ioctl: disk=%s, cmd=0x%x\n",
663                                                 disk->disk_name, cmd));
664
665         /*
666          * If we are in the middle of error recovery, don't let anyone
667          * else try and use this device.  Also, if error recovery fails, it
668          * may try and take the device offline, in which case all further
669          * access to the device is prohibited.
670          */
671         error = scsi_nonblockable_ioctl(sdp, cmd, p, filp);
672         if (!scsi_block_when_processing_errors(sdp) || !error)
673                 return error;
674
675         /*
676          * Send SCSI addressing ioctls directly to mid level, send other
677          * ioctls to block level and then onto mid level if they can't be
678          * resolved.
679          */
680         switch (cmd) {
681                 case SCSI_IOCTL_GET_IDLUN:
682                 case SCSI_IOCTL_GET_BUS_NUMBER:
683                         return scsi_ioctl(sdp, cmd, p);
684                 default:
685                         error = scsi_cmd_ioctl(filp, disk, cmd, p);
686                         if (error != -ENOTTY)
687                                 return error;
688         }
689         return scsi_ioctl(sdp, cmd, p);
690 }
691
692 static void set_media_not_present(struct scsi_disk *sdkp)
693 {
694         sdkp->media_present = 0;
695         sdkp->capacity = 0;
696         sdkp->device->changed = 1;
697 }
698
699 /**
700  *      sd_media_changed - check if our medium changed
701  *      @disk: kernel device descriptor 
702  *
703  *      Returns 0 if not applicable or no change; 1 if change
704  *
705  *      Note: this function is invoked from the block subsystem.
706  **/
707 static int sd_media_changed(struct gendisk *disk)
708 {
709         struct scsi_disk *sdkp = scsi_disk(disk);
710         struct scsi_device *sdp = sdkp->device;
711         int retval;
712
713         SCSI_LOG_HLQUEUE(3, printk("sd_media_changed: disk=%s\n",
714                                                 disk->disk_name));
715
716         if (!sdp->removable)
717                 return 0;
718
719         /*
720          * If the device is offline, don't send any commands - just pretend as
721          * if the command failed.  If the device ever comes back online, we
722          * can deal with it then.  It is only because of unrecoverable errors
723          * that we would ever take a device offline in the first place.
724          */
725         if (!scsi_device_online(sdp))
726                 goto not_present;
727
728         /*
729          * Using TEST_UNIT_READY enables differentiation between drive with
730          * no cartridge loaded - NOT READY, drive with changed cartridge -
731          * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
732          *
733          * Drives that auto spin down. eg iomega jaz 1G, will be started
734          * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
735          * sd_revalidate() is called.
736          */
737         retval = -ENODEV;
738         if (scsi_block_when_processing_errors(sdp))
739                 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES);
740
741         /*
742          * Unable to test, unit probably not ready.   This usually
743          * means there is no disc in the drive.  Mark as changed,
744          * and we will figure it out later once the drive is
745          * available again.
746          */
747         if (retval)
748                  goto not_present;
749
750         /*
751          * For removable scsi disk we have to recognise the presence
752          * of a disk in the drive. This is kept in the struct scsi_disk
753          * struct and tested at open !  Daniel Roche (dan@lectra.fr)
754          */
755         sdkp->media_present = 1;
756
757         retval = sdp->changed;
758         sdp->changed = 0;
759
760         return retval;
761
762 not_present:
763         set_media_not_present(sdkp);
764         return 1;
765 }
766
767 static int sd_sync_cache(struct scsi_device *sdp)
768 {
769         int retries, res;
770         struct scsi_sense_hdr sshdr;
771
772         if (!scsi_device_online(sdp))
773                 return -ENODEV;
774
775
776         for (retries = 3; retries > 0; --retries) {
777                 unsigned char cmd[10] = { 0 };
778
779                 cmd[0] = SYNCHRONIZE_CACHE;
780                 /*
781                  * Leave the rest of the command zero to indicate
782                  * flush everything.
783                  */
784                 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
785                                        SD_TIMEOUT, SD_MAX_RETRIES);
786                 if (res == 0)
787                         break;
788         }
789
790         if (res) {              printk(KERN_WARNING "FAILED\n  status = %x, message = %02x, "
791                                     "host = %d, driver = %02x\n  ",
792                                     status_byte(res), msg_byte(res),
793                                     host_byte(res), driver_byte(res));
794                         if (driver_byte(res) & DRIVER_SENSE)
795                                 scsi_print_sense_hdr("sd", &sshdr);
796         }
797
798         return res;
799 }
800
801 static int sd_issue_flush(struct device *dev, sector_t *error_sector)
802 {
803         int ret = 0;
804         struct scsi_device *sdp = to_scsi_device(dev);
805         struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
806
807         if (!sdkp)
808                return -ENODEV;
809
810         if (sdkp->WCE)
811                 ret = sd_sync_cache(sdp);
812         scsi_disk_put(sdkp);
813         return ret;
814 }
815
816 static void sd_prepare_flush(request_queue_t *q, struct request *rq)
817 {
818         memset(rq->cmd, 0, sizeof(rq->cmd));
819         rq->flags |= REQ_BLOCK_PC;
820         rq->timeout = SD_TIMEOUT;
821         rq->cmd[0] = SYNCHRONIZE_CACHE;
822         rq->cmd_len = 10;
823 }
824
825 static void sd_rescan(struct device *dev)
826 {
827         struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
828
829         if (sdkp) {
830                 sd_revalidate_disk(sdkp->disk);
831                 scsi_disk_put(sdkp);
832         }
833 }
834
835
836 #ifdef CONFIG_COMPAT
837 /* 
838  * This gets directly called from VFS. When the ioctl 
839  * is not recognized we go back to the other translation paths. 
840  */
841 static long sd_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
842 {
843         struct block_device *bdev = file->f_dentry->d_inode->i_bdev;
844         struct gendisk *disk = bdev->bd_disk;
845         struct scsi_device *sdev = scsi_disk(disk)->device;
846
847         /*
848          * If we are in the middle of error recovery, don't let anyone
849          * else try and use this device.  Also, if error recovery fails, it
850          * may try and take the device offline, in which case all further
851          * access to the device is prohibited.
852          */
853         if (!scsi_block_when_processing_errors(sdev))
854                 return -ENODEV;
855                
856         if (sdev->host->hostt->compat_ioctl) {
857                 int ret;
858
859                 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
860
861                 return ret;
862         }
863
864         /* 
865          * Let the static ioctl translation table take care of it.
866          */
867         return -ENOIOCTLCMD; 
868 }
869 #endif
870
871 static struct block_device_operations sd_fops = {
872         .owner                  = THIS_MODULE,
873         .open                   = sd_open,
874         .release                = sd_release,
875         .ioctl                  = sd_ioctl,
876         .getgeo                 = sd_getgeo,
877 #ifdef CONFIG_COMPAT
878         .compat_ioctl           = sd_compat_ioctl,
879 #endif
880         .media_changed          = sd_media_changed,
881         .revalidate_disk        = sd_revalidate_disk,
882 };
883
884 /**
885  *      sd_rw_intr - bottom half handler: called when the lower level
886  *      driver has completed (successfully or otherwise) a scsi command.
887  *      @SCpnt: mid-level's per command structure.
888  *
889  *      Note: potentially run from within an ISR. Must not block.
890  **/
891 static void sd_rw_intr(struct scsi_cmnd * SCpnt)
892 {
893         int result = SCpnt->result;
894         int this_count = SCpnt->request_bufflen;
895         int good_bytes = (result == 0 ? this_count : 0);
896         sector_t block_sectors = 1;
897         u64 first_err_block;
898         sector_t error_sector;
899         struct scsi_sense_hdr sshdr;
900         int sense_valid = 0;
901         int sense_deferred = 0;
902         int info_valid;
903
904         if (result) {
905                 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
906                 if (sense_valid)
907                         sense_deferred = scsi_sense_is_deferred(&sshdr);
908         }
909
910 #ifdef CONFIG_SCSI_LOGGING
911         SCSI_LOG_HLCOMPLETE(1, printk("sd_rw_intr: %s: res=0x%x\n", 
912                                 SCpnt->request->rq_disk->disk_name, result));
913         if (sense_valid) {
914                 SCSI_LOG_HLCOMPLETE(1, printk("sd_rw_intr: sb[respc,sk,asc,"
915                                 "ascq]=%x,%x,%x,%x\n", sshdr.response_code,
916                                 sshdr.sense_key, sshdr.asc, sshdr.ascq));
917         }
918 #endif
919         /*
920            Handle MEDIUM ERRORs that indicate partial success.  Since this is a
921            relatively rare error condition, no care is taken to avoid
922            unnecessary additional work such as memcpy's that could be avoided.
923          */
924         if (driver_byte(result) != 0 &&
925                  sense_valid && !sense_deferred) {
926                 switch (sshdr.sense_key) {
927                 case MEDIUM_ERROR:
928                         if (!blk_fs_request(SCpnt->request))
929                                 break;
930                         info_valid = scsi_get_sense_info_fld(
931                                 SCpnt->sense_buffer, SCSI_SENSE_BUFFERSIZE,
932                                 &first_err_block);
933                         /*
934                          * May want to warn and skip if following cast results
935                          * in actual truncation (if sector_t < 64 bits)
936                          */
937                         error_sector = (sector_t)first_err_block;
938                         if (SCpnt->request->bio != NULL)
939                                 block_sectors = bio_sectors(SCpnt->request->bio);
940                         switch (SCpnt->device->sector_size) {
941                         case 1024:
942                                 error_sector <<= 1;
943                                 if (block_sectors < 2)
944                                         block_sectors = 2;
945                                 break;
946                         case 2048:
947                                 error_sector <<= 2;
948                                 if (block_sectors < 4)
949                                         block_sectors = 4;
950                                 break;
951                         case 4096:
952                                 error_sector <<=3;
953                                 if (block_sectors < 8)
954                                         block_sectors = 8;
955                                 break;
956                         case 256:
957                                 error_sector >>= 1;
958                                 break;
959                         default:
960                                 break;
961                         }
962
963                         error_sector &= ~(block_sectors - 1);
964                         good_bytes = (error_sector - SCpnt->request->sector) << 9;
965                         if (good_bytes < 0 || good_bytes >= this_count)
966                                 good_bytes = 0;
967                         break;
968
969                 case RECOVERED_ERROR: /* an error occurred, but it recovered */
970                 case NO_SENSE: /* LLDD got sense data */
971                         /*
972                          * Inform the user, but make sure that it's not treated
973                          * as a hard error.
974                          */
975                         scsi_print_sense("sd", SCpnt);
976                         SCpnt->result = 0;
977                         memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
978                         good_bytes = this_count;
979                         break;
980
981                 case ILLEGAL_REQUEST:
982                         if (SCpnt->device->use_10_for_rw &&
983                             (SCpnt->cmnd[0] == READ_10 ||
984                              SCpnt->cmnd[0] == WRITE_10))
985                                 SCpnt->device->use_10_for_rw = 0;
986                         if (SCpnt->device->use_10_for_ms &&
987                             (SCpnt->cmnd[0] == MODE_SENSE_10 ||
988                              SCpnt->cmnd[0] == MODE_SELECT_10))
989                                 SCpnt->device->use_10_for_ms = 0;
990                         break;
991
992                 default:
993                         break;
994                 }
995         }
996         /*
997          * This calls the generic completion function, now that we know
998          * how many actual sectors finished, and how many sectors we need
999          * to say have failed.
1000          */
1001         scsi_io_completion(SCpnt, good_bytes, block_sectors << 9);
1002 }
1003
1004 static int media_not_present(struct scsi_disk *sdkp,
1005                              struct scsi_sense_hdr *sshdr)
1006 {
1007
1008         if (!scsi_sense_valid(sshdr))
1009                 return 0;
1010         /* not invoked for commands that could return deferred errors */
1011         if (sshdr->sense_key != NOT_READY &&
1012             sshdr->sense_key != UNIT_ATTENTION)
1013                 return 0;
1014         if (sshdr->asc != 0x3A) /* medium not present */
1015                 return 0;
1016
1017         set_media_not_present(sdkp);
1018         return 1;
1019 }
1020
1021 /*
1022  * spinup disk - called only in sd_revalidate_disk()
1023  */
1024 static void
1025 sd_spinup_disk(struct scsi_disk *sdkp, char *diskname)
1026 {
1027         unsigned char cmd[10];
1028         unsigned long spintime_expire = 0;
1029         int retries, spintime;
1030         unsigned int the_result;
1031         struct scsi_sense_hdr sshdr;
1032         int sense_valid = 0;
1033
1034         spintime = 0;
1035
1036         /* Spin up drives, as required.  Only do this at boot time */
1037         /* Spinup needs to be done for module loads too. */
1038         do {
1039                 retries = 0;
1040
1041                 do {
1042                         cmd[0] = TEST_UNIT_READY;
1043                         memset((void *) &cmd[1], 0, 9);
1044
1045                         the_result = scsi_execute_req(sdkp->device, cmd,
1046                                                       DMA_NONE, NULL, 0,
1047                                                       &sshdr, SD_TIMEOUT,
1048                                                       SD_MAX_RETRIES);
1049
1050                         if (the_result)
1051                                 sense_valid = scsi_sense_valid(&sshdr);
1052                         retries++;
1053                 } while (retries < 3 && 
1054                          (!scsi_status_is_good(the_result) ||
1055                           ((driver_byte(the_result) & DRIVER_SENSE) &&
1056                           sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
1057
1058                 /*
1059                  * If the drive has indicated to us that it doesn't have
1060                  * any media in it, don't bother with any of the rest of
1061                  * this crap.
1062                  */
1063                 if (media_not_present(sdkp, &sshdr))
1064                         return;
1065
1066                 if ((driver_byte(the_result) & DRIVER_SENSE) == 0) {
1067                         /* no sense, TUR either succeeded or failed
1068                          * with a status error */
1069                         if(!spintime && !scsi_status_is_good(the_result))
1070                                 printk(KERN_NOTICE "%s: Unit Not Ready, "
1071                                        "error = 0x%x\n", diskname, the_result);
1072                         break;
1073                 }
1074                                         
1075                 /*
1076                  * The device does not want the automatic start to be issued.
1077                  */
1078                 if (sdkp->device->no_start_on_add) {
1079                         break;
1080                 }
1081
1082                 /*
1083                  * If manual intervention is required, or this is an
1084                  * absent USB storage device, a spinup is meaningless.
1085                  */
1086                 if (sense_valid &&
1087                     sshdr.sense_key == NOT_READY &&
1088                     sshdr.asc == 4 && sshdr.ascq == 3) {
1089                         break;          /* manual intervention required */
1090
1091                 /*
1092                  * Issue command to spin up drive when not ready
1093                  */
1094                 } else if (sense_valid && sshdr.sense_key == NOT_READY) {
1095                         if (!spintime) {
1096                                 printk(KERN_NOTICE "%s: Spinning up disk...",
1097                                        diskname);
1098                                 cmd[0] = START_STOP;
1099                                 cmd[1] = 1;     /* Return immediately */
1100                                 memset((void *) &cmd[2], 0, 8);
1101                                 cmd[4] = 1;     /* Start spin cycle */
1102                                 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
1103                                                  NULL, 0, &sshdr,
1104                                                  SD_TIMEOUT, SD_MAX_RETRIES);
1105                                 spintime_expire = jiffies + 100 * HZ;
1106                                 spintime = 1;
1107                         }
1108                         /* Wait 1 second for next try */
1109                         msleep(1000);
1110                         printk(".");
1111
1112                 /*
1113                  * Wait for USB flash devices with slow firmware.
1114                  * Yes, this sense key/ASC combination shouldn't
1115                  * occur here.  It's characteristic of these devices.
1116                  */
1117                 } else if (sense_valid &&
1118                                 sshdr.sense_key == UNIT_ATTENTION &&
1119                                 sshdr.asc == 0x28) {
1120                         if (!spintime) {
1121                                 spintime_expire = jiffies + 5 * HZ;
1122                                 spintime = 1;
1123                         }
1124                         /* Wait 1 second for next try */
1125                         msleep(1000);
1126                 } else {
1127                         /* we don't understand the sense code, so it's
1128                          * probably pointless to loop */
1129                         if(!spintime) {
1130                                 printk(KERN_NOTICE "%s: Unit Not Ready, "
1131                                         "sense:\n", diskname);
1132                                 scsi_print_sense_hdr("", &sshdr);
1133                         }
1134                         break;
1135                 }
1136                                 
1137         } while (spintime && time_before_eq(jiffies, spintime_expire));
1138
1139         if (spintime) {
1140                 if (scsi_status_is_good(the_result))
1141                         printk("ready\n");
1142                 else
1143                         printk("not responding...\n");
1144         }
1145 }
1146
1147 /*
1148  * read disk capacity
1149  */
1150 static void
1151 sd_read_capacity(struct scsi_disk *sdkp, char *diskname,
1152                  unsigned char *buffer)
1153 {
1154         unsigned char cmd[16];
1155         int the_result, retries;
1156         int sector_size = 0;
1157         int longrc = 0;
1158         struct scsi_sense_hdr sshdr;
1159         int sense_valid = 0;
1160         struct scsi_device *sdp = sdkp->device;
1161
1162 repeat:
1163         retries = 3;
1164         do {
1165                 if (longrc) {
1166                         memset((void *) cmd, 0, 16);
1167                         cmd[0] = SERVICE_ACTION_IN;
1168                         cmd[1] = SAI_READ_CAPACITY_16;
1169                         cmd[13] = 12;
1170                         memset((void *) buffer, 0, 12);
1171                 } else {
1172                         cmd[0] = READ_CAPACITY;
1173                         memset((void *) &cmd[1], 0, 9);
1174                         memset((void *) buffer, 0, 8);
1175                 }
1176                 
1177                 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1178                                               buffer, longrc ? 12 : 8, &sshdr,
1179                                               SD_TIMEOUT, SD_MAX_RETRIES);
1180
1181                 if (media_not_present(sdkp, &sshdr))
1182                         return;
1183
1184                 if (the_result)
1185                         sense_valid = scsi_sense_valid(&sshdr);
1186                 retries--;
1187
1188         } while (the_result && retries);
1189
1190         if (the_result && !longrc) {
1191                 printk(KERN_NOTICE "%s : READ CAPACITY failed.\n"
1192                        "%s : status=%x, message=%02x, host=%d, driver=%02x \n",
1193                        diskname, diskname,
1194                        status_byte(the_result),
1195                        msg_byte(the_result),
1196                        host_byte(the_result),
1197                        driver_byte(the_result));
1198
1199                 if (driver_byte(the_result) & DRIVER_SENSE)
1200                         scsi_print_sense_hdr("sd", &sshdr);
1201                 else
1202                         printk("%s : sense not available. \n", diskname);
1203
1204                 /* Set dirty bit for removable devices if not ready -
1205                  * sometimes drives will not report this properly. */
1206                 if (sdp->removable &&
1207                     sense_valid && sshdr.sense_key == NOT_READY)
1208                         sdp->changed = 1;
1209
1210                 /* Either no media are present but the drive didn't tell us,
1211                    or they are present but the read capacity command fails */
1212                 /* sdkp->media_present = 0; -- not always correct */
1213                 sdkp->capacity = 0x200000; /* 1 GB - random */
1214
1215                 return;
1216         } else if (the_result && longrc) {
1217                 /* READ CAPACITY(16) has been failed */
1218                 printk(KERN_NOTICE "%s : READ CAPACITY(16) failed.\n"
1219                        "%s : status=%x, message=%02x, host=%d, driver=%02x \n",
1220                        diskname, diskname,
1221                        status_byte(the_result),
1222                        msg_byte(the_result),
1223                        host_byte(the_result),
1224                        driver_byte(the_result));
1225                 printk(KERN_NOTICE "%s : use 0xffffffff as device size\n",
1226                        diskname);
1227                 
1228                 sdkp->capacity = 1 + (sector_t) 0xffffffff;             
1229                 goto got_data;
1230         }       
1231         
1232         if (!longrc) {
1233                 sector_size = (buffer[4] << 24) |
1234                         (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
1235                 if (buffer[0] == 0xff && buffer[1] == 0xff &&
1236                     buffer[2] == 0xff && buffer[3] == 0xff) {
1237                         if(sizeof(sdkp->capacity) > 4) {
1238                                 printk(KERN_NOTICE "%s : very big device. try to use"
1239                                        " READ CAPACITY(16).\n", diskname);
1240                                 longrc = 1;
1241                                 goto repeat;
1242                         }
1243                         printk(KERN_ERR "%s: too big for this kernel.  Use a "
1244                                "kernel compiled with support for large block "
1245                                "devices.\n", diskname);
1246                         sdkp->capacity = 0;
1247                         goto got_data;
1248                 }
1249                 sdkp->capacity = 1 + (((sector_t)buffer[0] << 24) |
1250                         (buffer[1] << 16) |
1251                         (buffer[2] << 8) |
1252                         buffer[3]);                     
1253         } else {
1254                 sdkp->capacity = 1 + (((u64)buffer[0] << 56) |
1255                         ((u64)buffer[1] << 48) |
1256                         ((u64)buffer[2] << 40) |
1257                         ((u64)buffer[3] << 32) |
1258                         ((sector_t)buffer[4] << 24) |
1259                         ((sector_t)buffer[5] << 16) |
1260                         ((sector_t)buffer[6] << 8)  |
1261                         (sector_t)buffer[7]);
1262                         
1263                 sector_size = (buffer[8] << 24) |
1264                         (buffer[9] << 16) | (buffer[10] << 8) | buffer[11];
1265         }       
1266
1267         /* Some devices return the total number of sectors, not the
1268          * highest sector number.  Make the necessary adjustment. */
1269         if (sdp->fix_capacity)
1270                 --sdkp->capacity;
1271
1272 got_data:
1273         if (sector_size == 0) {
1274                 sector_size = 512;
1275                 printk(KERN_NOTICE "%s : sector size 0 reported, "
1276                        "assuming 512.\n", diskname);
1277         }
1278
1279         if (sector_size != 512 &&
1280             sector_size != 1024 &&
1281             sector_size != 2048 &&
1282             sector_size != 4096 &&
1283             sector_size != 256) {
1284                 printk(KERN_NOTICE "%s : unsupported sector size "
1285                        "%d.\n", diskname, sector_size);
1286                 /*
1287                  * The user might want to re-format the drive with
1288                  * a supported sectorsize.  Once this happens, it
1289                  * would be relatively trivial to set the thing up.
1290                  * For this reason, we leave the thing in the table.
1291                  */
1292                 sdkp->capacity = 0;
1293                 /*
1294                  * set a bogus sector size so the normal read/write
1295                  * logic in the block layer will eventually refuse any
1296                  * request on this device without tripping over power
1297                  * of two sector size assumptions
1298                  */
1299                 sector_size = 512;
1300         }
1301         {
1302                 /*
1303                  * The msdos fs needs to know the hardware sector size
1304                  * So I have created this table. See ll_rw_blk.c
1305                  * Jacques Gelinas (Jacques@solucorp.qc.ca)
1306                  */
1307                 int hard_sector = sector_size;
1308                 sector_t sz = (sdkp->capacity/2) * (hard_sector/256);
1309                 request_queue_t *queue = sdp->request_queue;
1310                 sector_t mb = sz;
1311
1312                 blk_queue_hardsect_size(queue, hard_sector);
1313                 /* avoid 64-bit division on 32-bit platforms */
1314                 sector_div(sz, 625);
1315                 mb -= sz - 974;
1316                 sector_div(mb, 1950);
1317
1318                 printk(KERN_NOTICE "SCSI device %s: "
1319                        "%llu %d-byte hdwr sectors (%llu MB)\n",
1320                        diskname, (unsigned long long)sdkp->capacity,
1321                        hard_sector, (unsigned long long)mb);
1322         }
1323
1324         /* Rescale capacity to 512-byte units */
1325         if (sector_size == 4096)
1326                 sdkp->capacity <<= 3;
1327         else if (sector_size == 2048)
1328                 sdkp->capacity <<= 2;
1329         else if (sector_size == 1024)
1330                 sdkp->capacity <<= 1;
1331         else if (sector_size == 256)
1332                 sdkp->capacity >>= 1;
1333
1334         sdkp->device->sector_size = sector_size;
1335 }
1336
1337 /* called with buffer of length 512 */
1338 static inline int
1339 sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
1340                  unsigned char *buffer, int len, struct scsi_mode_data *data,
1341                  struct scsi_sense_hdr *sshdr)
1342 {
1343         return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1344                                SD_TIMEOUT, SD_MAX_RETRIES, data,
1345                                sshdr);
1346 }
1347
1348 /*
1349  * read write protect setting, if possible - called only in sd_revalidate_disk()
1350  * called with buffer of length SD_BUF_SIZE
1351  */
1352 static void
1353 sd_read_write_protect_flag(struct scsi_disk *sdkp, char *diskname,
1354                            unsigned char *buffer)
1355 {
1356         int res;
1357         struct scsi_device *sdp = sdkp->device;
1358         struct scsi_mode_data data;
1359
1360         set_disk_ro(sdkp->disk, 0);
1361         if (sdp->skip_ms_page_3f) {
1362                 printk(KERN_NOTICE "%s: assuming Write Enabled\n", diskname);
1363                 return;
1364         }
1365
1366         if (sdp->use_192_bytes_for_3f) {
1367                 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1368         } else {
1369                 /*
1370                  * First attempt: ask for all pages (0x3F), but only 4 bytes.
1371                  * We have to start carefully: some devices hang if we ask
1372                  * for more than is available.
1373                  */
1374                 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1375
1376                 /*
1377                  * Second attempt: ask for page 0 When only page 0 is
1378                  * implemented, a request for page 3F may return Sense Key
1379                  * 5: Illegal Request, Sense Code 24: Invalid field in
1380                  * CDB.
1381                  */
1382                 if (!scsi_status_is_good(res))
1383                         res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1384
1385                 /*
1386                  * Third attempt: ask 255 bytes, as we did earlier.
1387                  */
1388                 if (!scsi_status_is_good(res))
1389                         res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
1390                                                &data, NULL);
1391         }
1392
1393         if (!scsi_status_is_good(res)) {
1394                 printk(KERN_WARNING
1395                        "%s: test WP failed, assume Write Enabled\n", diskname);
1396         } else {
1397                 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
1398                 set_disk_ro(sdkp->disk, sdkp->write_prot);
1399                 printk(KERN_NOTICE "%s: Write Protect is %s\n", diskname,
1400                        sdkp->write_prot ? "on" : "off");
1401                 printk(KERN_DEBUG "%s: Mode Sense: %02x %02x %02x %02x\n",
1402                        diskname, buffer[0], buffer[1], buffer[2], buffer[3]);
1403         }
1404 }
1405
1406 /*
1407  * sd_read_cache_type - called only from sd_revalidate_disk()
1408  * called with buffer of length SD_BUF_SIZE
1409  */
1410 static void
1411 sd_read_cache_type(struct scsi_disk *sdkp, char *diskname,
1412                    unsigned char *buffer)
1413 {
1414         int len = 0, res;
1415         struct scsi_device *sdp = sdkp->device;
1416
1417         int dbd;
1418         int modepage;
1419         struct scsi_mode_data data;
1420         struct scsi_sense_hdr sshdr;
1421
1422         if (sdp->skip_ms_page_8)
1423                 goto defaults;
1424
1425         if (sdp->type == TYPE_RBC) {
1426                 modepage = 6;
1427                 dbd = 8;
1428         } else {
1429                 modepage = 8;
1430                 dbd = 0;
1431         }
1432
1433         /* cautiously ask */
1434         res = sd_do_mode_sense(sdp, dbd, modepage, buffer, 4, &data, &sshdr);
1435
1436         if (!scsi_status_is_good(res))
1437                 goto bad_sense;
1438
1439         if (!data.header_length) {
1440                 modepage = 6;
1441                 printk(KERN_ERR "%s: missing header in MODE_SENSE response\n",
1442                        diskname);
1443         }
1444
1445         /* that went OK, now ask for the proper length */
1446         len = data.length;
1447
1448         /*
1449          * We're only interested in the first three bytes, actually.
1450          * But the data cache page is defined for the first 20.
1451          */
1452         if (len < 3)
1453                 goto bad_sense;
1454         if (len > 20)
1455                 len = 20;
1456
1457         /* Take headers and block descriptors into account */
1458         len += data.header_length + data.block_descriptor_length;
1459         if (len > SD_BUF_SIZE)
1460                 goto bad_sense;
1461
1462         /* Get the data */
1463         res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len, &data, &sshdr);
1464
1465         if (scsi_status_is_good(res)) {
1466                 int ct = 0;
1467                 int offset = data.header_length + data.block_descriptor_length;
1468
1469                 if (offset >= SD_BUF_SIZE - 2) {
1470                         printk(KERN_ERR "%s: malformed MODE SENSE response",
1471                                 diskname);
1472                         goto defaults;
1473                 }
1474
1475                 if ((buffer[offset] & 0x3f) != modepage) {
1476                         printk(KERN_ERR "%s: got wrong page\n", diskname);
1477                         goto defaults;
1478                 }
1479
1480                 if (modepage == 8) {
1481                         sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
1482                         sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
1483                 } else {
1484                         sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
1485                         sdkp->RCD = 0;
1486                 }
1487
1488                 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
1489                 if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw) {
1490                         printk(KERN_NOTICE "SCSI device %s: uses "
1491                                "READ/WRITE(6), disabling FUA\n", diskname);
1492                         sdkp->DPOFUA = 0;
1493                 }
1494
1495                 ct =  sdkp->RCD + 2*sdkp->WCE;
1496
1497                 printk(KERN_NOTICE "SCSI device %s: drive cache: %s%s\n",
1498                        diskname, sd_cache_types[ct],
1499                        sdkp->DPOFUA ? " w/ FUA" : "");
1500
1501                 return;
1502         }
1503
1504 bad_sense:
1505         if (scsi_sense_valid(&sshdr) &&
1506             sshdr.sense_key == ILLEGAL_REQUEST &&
1507             sshdr.asc == 0x24 && sshdr.ascq == 0x0)
1508                 printk(KERN_NOTICE "%s: cache data unavailable\n",
1509                        diskname);       /* Invalid field in CDB */
1510         else
1511                 printk(KERN_ERR "%s: asking for cache data failed\n",
1512                        diskname);
1513
1514 defaults:
1515         printk(KERN_ERR "%s: assuming drive cache: write through\n",
1516                diskname);
1517         sdkp->WCE = 0;
1518         sdkp->RCD = 0;
1519         sdkp->DPOFUA = 0;
1520 }
1521
1522 /**
1523  *      sd_revalidate_disk - called the first time a new disk is seen,
1524  *      performs disk spin up, read_capacity, etc.
1525  *      @disk: struct gendisk we care about
1526  **/
1527 static int sd_revalidate_disk(struct gendisk *disk)
1528 {
1529         struct scsi_disk *sdkp = scsi_disk(disk);
1530         struct scsi_device *sdp = sdkp->device;
1531         unsigned char *buffer;
1532         unsigned ordered;
1533
1534         SCSI_LOG_HLQUEUE(3, printk("sd_revalidate_disk: disk=%s\n", disk->disk_name));
1535
1536         /*
1537          * If the device is offline, don't try and read capacity or any
1538          * of the other niceties.
1539          */
1540         if (!scsi_device_online(sdp))
1541                 goto out;
1542
1543         buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL | __GFP_DMA);
1544         if (!buffer) {
1545                 printk(KERN_WARNING "(sd_revalidate_disk:) Memory allocation "
1546                        "failure.\n");
1547                 goto out;
1548         }
1549
1550         /* defaults, until the device tells us otherwise */
1551         sdp->sector_size = 512;
1552         sdkp->capacity = 0;
1553         sdkp->media_present = 1;
1554         sdkp->write_prot = 0;
1555         sdkp->WCE = 0;
1556         sdkp->RCD = 0;
1557
1558         sd_spinup_disk(sdkp, disk->disk_name);
1559
1560         /*
1561          * Without media there is no reason to ask; moreover, some devices
1562          * react badly if we do.
1563          */
1564         if (sdkp->media_present) {
1565                 sd_read_capacity(sdkp, disk->disk_name, buffer);
1566                 sd_read_write_protect_flag(sdkp, disk->disk_name, buffer);
1567                 sd_read_cache_type(sdkp, disk->disk_name, buffer);
1568         }
1569
1570         /*
1571          * We now have all cache related info, determine how we deal
1572          * with ordered requests.  Note that as the current SCSI
1573          * dispatch function can alter request order, we cannot use
1574          * QUEUE_ORDERED_TAG_* even when ordered tag is supported.
1575          */
1576         if (sdkp->WCE)
1577                 ordered = sdkp->DPOFUA
1578                         ? QUEUE_ORDERED_DRAIN_FUA : QUEUE_ORDERED_DRAIN_FLUSH;
1579         else
1580                 ordered = QUEUE_ORDERED_DRAIN;
1581
1582         blk_queue_ordered(sdkp->disk->queue, ordered, sd_prepare_flush);
1583
1584         set_capacity(disk, sdkp->capacity);
1585         kfree(buffer);
1586
1587  out:
1588         return 0;
1589 }
1590
1591 /**
1592  *      sd_probe - called during driver initialization and whenever a
1593  *      new scsi device is attached to the system. It is called once
1594  *      for each scsi device (not just disks) present.
1595  *      @dev: pointer to device object
1596  *
1597  *      Returns 0 if successful (or not interested in this scsi device 
1598  *      (e.g. scanner)); 1 when there is an error.
1599  *
1600  *      Note: this function is invoked from the scsi mid-level.
1601  *      This function sets up the mapping between a given 
1602  *      <host,channel,id,lun> (found in sdp) and new device name 
1603  *      (e.g. /dev/sda). More precisely it is the block device major 
1604  *      and minor number that is chosen here.
1605  *
1606  *      Assume sd_attach is not re-entrant (for time being)
1607  *      Also think about sd_attach() and sd_remove() running coincidentally.
1608  **/
1609 static int sd_probe(struct device *dev)
1610 {
1611         struct scsi_device *sdp = to_scsi_device(dev);
1612         struct scsi_disk *sdkp;
1613         struct gendisk *gd;
1614         u32 index;
1615         int error;
1616
1617         error = -ENODEV;
1618         if (sdp->type != TYPE_DISK && sdp->type != TYPE_MOD && sdp->type != TYPE_RBC)
1619                 goto out;
1620
1621         SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
1622                                         "sd_attach\n"));
1623
1624         error = -ENOMEM;
1625         sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
1626         if (!sdkp)
1627                 goto out;
1628
1629         gd = alloc_disk(16);
1630         if (!gd)
1631                 goto out_free;
1632
1633         if (!idr_pre_get(&sd_index_idr, GFP_KERNEL))
1634                 goto out_put;
1635
1636         spin_lock(&sd_index_lock);
1637         error = idr_get_new(&sd_index_idr, NULL, &index);
1638         spin_unlock(&sd_index_lock);
1639
1640         if (index >= SD_MAX_DISKS)
1641                 error = -EBUSY;
1642         if (error)
1643                 goto out_put;
1644
1645         class_device_initialize(&sdkp->cdev);
1646         sdkp->cdev.dev = &sdp->sdev_gendev;
1647         sdkp->cdev.class = &sd_disk_class;
1648         strncpy(sdkp->cdev.class_id, sdp->sdev_gendev.bus_id, BUS_ID_SIZE);
1649
1650         if (class_device_add(&sdkp->cdev))
1651                 goto out_put;
1652
1653         get_device(&sdp->sdev_gendev);
1654
1655         sdkp->device = sdp;
1656         sdkp->driver = &sd_template;
1657         sdkp->disk = gd;
1658         sdkp->index = index;
1659         sdkp->openers = 0;
1660
1661         if (!sdp->timeout) {
1662                 if (sdp->type != TYPE_MOD)
1663                         sdp->timeout = SD_TIMEOUT;
1664                 else
1665                         sdp->timeout = SD_MOD_TIMEOUT;
1666         }
1667
1668         gd->major = sd_major((index & 0xf0) >> 4);
1669         gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
1670         gd->minors = 16;
1671         gd->fops = &sd_fops;
1672
1673         if (index < 26) {
1674                 sprintf(gd->disk_name, "sd%c", 'a' + index % 26);
1675         } else if (index < (26 + 1) * 26) {
1676                 sprintf(gd->disk_name, "sd%c%c",
1677                         'a' + index / 26 - 1,'a' + index % 26);
1678         } else {
1679                 const unsigned int m1 = (index / 26 - 1) / 26 - 1;
1680                 const unsigned int m2 = (index / 26 - 1) % 26;
1681                 const unsigned int m3 =  index % 26;
1682                 sprintf(gd->disk_name, "sd%c%c%c",
1683                         'a' + m1, 'a' + m2, 'a' + m3);
1684         }
1685
1686         gd->private_data = &sdkp->driver;
1687         gd->queue = sdkp->device->request_queue;
1688
1689         sd_revalidate_disk(gd);
1690
1691         gd->driverfs_dev = &sdp->sdev_gendev;
1692         gd->flags = GENHD_FL_DRIVERFS;
1693         if (sdp->removable)
1694                 gd->flags |= GENHD_FL_REMOVABLE;
1695
1696         dev_set_drvdata(dev, sdkp);
1697         add_disk(gd);
1698
1699         sdev_printk(KERN_NOTICE, sdp, "Attached scsi %sdisk %s\n",
1700                     sdp->removable ? "removable " : "", gd->disk_name);
1701
1702         return 0;
1703
1704  out_put:
1705         put_disk(gd);
1706  out_free:
1707         kfree(sdkp);
1708  out:
1709         return error;
1710 }
1711
1712 /**
1713  *      sd_remove - called whenever a scsi disk (previously recognized by
1714  *      sd_probe) is detached from the system. It is called (potentially
1715  *      multiple times) during sd module unload.
1716  *      @sdp: pointer to mid level scsi device object
1717  *
1718  *      Note: this function is invoked from the scsi mid-level.
1719  *      This function potentially frees up a device name (e.g. /dev/sdc)
1720  *      that could be re-used by a subsequent sd_probe().
1721  *      This function is not called when the built-in sd driver is "exit-ed".
1722  **/
1723 static int sd_remove(struct device *dev)
1724 {
1725         struct scsi_disk *sdkp = dev_get_drvdata(dev);
1726
1727         class_device_del(&sdkp->cdev);
1728         del_gendisk(sdkp->disk);
1729         sd_shutdown(dev);
1730
1731         mutex_lock(&sd_ref_mutex);
1732         dev_set_drvdata(dev, NULL);
1733         class_device_put(&sdkp->cdev);
1734         mutex_unlock(&sd_ref_mutex);
1735
1736         return 0;
1737 }
1738
1739 /**
1740  *      scsi_disk_release - Called to free the scsi_disk structure
1741  *      @cdev: pointer to embedded class device
1742  *
1743  *      sd_ref_mutex must be held entering this routine.  Because it is
1744  *      called on last put, you should always use the scsi_disk_get()
1745  *      scsi_disk_put() helpers which manipulate the semaphore directly
1746  *      and never do a direct class_device_put().
1747  **/
1748 static void scsi_disk_release(struct class_device *cdev)
1749 {
1750         struct scsi_disk *sdkp = to_scsi_disk(cdev);
1751         struct gendisk *disk = sdkp->disk;
1752         
1753         spin_lock(&sd_index_lock);
1754         idr_remove(&sd_index_idr, sdkp->index);
1755         spin_unlock(&sd_index_lock);
1756
1757         disk->private_data = NULL;
1758         put_disk(disk);
1759         put_device(&sdkp->device->sdev_gendev);
1760
1761         kfree(sdkp);
1762 }
1763
1764 /*
1765  * Send a SYNCHRONIZE CACHE instruction down to the device through
1766  * the normal SCSI command structure.  Wait for the command to
1767  * complete.
1768  */
1769 static void sd_shutdown(struct device *dev)
1770 {
1771         struct scsi_device *sdp = to_scsi_device(dev);
1772         struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
1773
1774         if (!sdkp)
1775                 return;         /* this can happen */
1776
1777         if (sdkp->WCE) {
1778                 printk(KERN_NOTICE "Synchronizing SCSI cache for disk %s: \n",
1779                                 sdkp->disk->disk_name);
1780                 sd_sync_cache(sdp);
1781         }
1782         scsi_disk_put(sdkp);
1783 }
1784
1785 /**
1786  *      init_sd - entry point for this driver (both when built in or when
1787  *      a module).
1788  *
1789  *      Note: this function registers this driver with the scsi mid-level.
1790  **/
1791 static int __init init_sd(void)
1792 {
1793         int majors = 0, i;
1794
1795         SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
1796
1797         for (i = 0; i < SD_MAJORS; i++)
1798                 if (register_blkdev(sd_major(i), "sd") == 0)
1799                         majors++;
1800
1801         if (!majors)
1802                 return -ENODEV;
1803
1804         class_register(&sd_disk_class);
1805
1806         return scsi_register_driver(&sd_template.gendrv);
1807 }
1808
1809 /**
1810  *      exit_sd - exit point for this driver (when it is a module).
1811  *
1812  *      Note: this function unregisters this driver from the scsi mid-level.
1813  **/
1814 static void __exit exit_sd(void)
1815 {
1816         int i;
1817
1818         SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
1819
1820         scsi_unregister_driver(&sd_template.gendrv);
1821         for (i = 0; i < SD_MAJORS; i++)
1822                 unregister_blkdev(sd_major(i), "sd");
1823
1824         class_unregister(&sd_disk_class);
1825 }
1826
1827 module_init(init_sd);
1828 module_exit(exit_sd);