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