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