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