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