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