Fix common misspellings
[linux-flexiantxendom0-3.2.10.git] / drivers / scsi / sr.c
1 /*
2  *  sr.c Copyright (C) 1992 David Giller
3  *           Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
4  *
5  *  adapted from:
6  *      sd.c Copyright (C) 1992 Drew Eckhardt
7  *      Linux scsi disk driver by
8  *              Drew Eckhardt <drew@colorado.edu>
9  *
10  *      Modified by Eric Youngdale ericy@andante.org to
11  *      add scatter-gather, multiple outstanding request, and other
12  *      enhancements.
13  *
14  *      Modified by Eric Youngdale eric@andante.org to support loadable
15  *      low-level scsi drivers.
16  *
17  *      Modified by Thomas Quinot thomas@melchior.cuivre.fdn.fr to
18  *      provide auto-eject.
19  *
20  *      Modified by Gerd Knorr <kraxel@cs.tu-berlin.de> to support the
21  *      generic cdrom interface
22  *
23  *      Modified by Jens Axboe <axboe@suse.de> - Uniform sr_packet()
24  *      interface, capabilities probe additions, ioctl cleanups, etc.
25  *
26  *      Modified by Richard Gooch <rgooch@atnf.csiro.au> to support devfs
27  *
28  *      Modified by Jens Axboe <axboe@suse.de> - support DVD-RAM
29  *      transparently and lose the GHOST hack
30  *
31  *      Modified by Arnaldo Carvalho de Melo <acme@conectiva.com.br>
32  *      check resource allocation in sr_init and some cleanups
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/string.h>
41 #include <linux/errno.h>
42 #include <linux/cdrom.h>
43 #include <linux/interrupt.h>
44 #include <linux/init.h>
45 #include <linux/blkdev.h>
46 #include <linux/mutex.h>
47 #include <linux/slab.h>
48 #include <asm/uaccess.h>
49
50 #include <scsi/scsi.h>
51 #include <scsi/scsi_dbg.h>
52 #include <scsi/scsi_device.h>
53 #include <scsi/scsi_driver.h>
54 #include <scsi/scsi_cmnd.h>
55 #include <scsi/scsi_eh.h>
56 #include <scsi/scsi_host.h>
57 #include <scsi/scsi_ioctl.h>    /* For the door lock/unlock commands */
58
59 #include "scsi_logging.h"
60 #include "sr.h"
61
62
63 MODULE_DESCRIPTION("SCSI cdrom (sr) driver");
64 MODULE_LICENSE("GPL");
65 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_CDROM_MAJOR);
66 MODULE_ALIAS_SCSI_DEVICE(TYPE_ROM);
67 MODULE_ALIAS_SCSI_DEVICE(TYPE_WORM);
68
69 #define SR_DISKS        256
70
71 #define SR_CAPABILITIES \
72         (CDC_CLOSE_TRAY|CDC_OPEN_TRAY|CDC_LOCK|CDC_SELECT_SPEED| \
73          CDC_SELECT_DISC|CDC_MULTI_SESSION|CDC_MCN|CDC_MEDIA_CHANGED| \
74          CDC_PLAY_AUDIO|CDC_RESET|CDC_DRIVE_STATUS| \
75          CDC_CD_R|CDC_CD_RW|CDC_DVD|CDC_DVD_R|CDC_DVD_RAM|CDC_GENERIC_PACKET| \
76          CDC_MRW|CDC_MRW_W|CDC_RAM)
77
78 static DEFINE_MUTEX(sr_mutex);
79 static int sr_probe(struct device *);
80 static int sr_remove(struct device *);
81 static int sr_done(struct scsi_cmnd *);
82
83 static struct scsi_driver sr_template = {
84         .owner                  = THIS_MODULE,
85         .gendrv = {
86                 .name           = "sr",
87                 .probe          = sr_probe,
88                 .remove         = sr_remove,
89         },
90         .done                   = sr_done,
91 };
92
93 static unsigned long sr_index_bits[SR_DISKS / BITS_PER_LONG];
94 static DEFINE_SPINLOCK(sr_index_lock);
95
96 /* This semaphore is used to mediate the 0->1 reference get in the
97  * face of object destruction (i.e. we can't allow a get on an
98  * object after last put) */
99 static DEFINE_MUTEX(sr_ref_mutex);
100
101 static int sr_open(struct cdrom_device_info *, int);
102 static void sr_release(struct cdrom_device_info *);
103
104 static void get_sectorsize(struct scsi_cd *);
105 static void get_capabilities(struct scsi_cd *);
106
107 static unsigned int sr_check_events(struct cdrom_device_info *cdi,
108                                     unsigned int clearing, int slot);
109 static int sr_packet(struct cdrom_device_info *, struct packet_command *);
110
111 static struct cdrom_device_ops sr_dops = {
112         .open                   = sr_open,
113         .release                = sr_release,
114         .drive_status           = sr_drive_status,
115         .check_events           = sr_check_events,
116         .tray_move              = sr_tray_move,
117         .lock_door              = sr_lock_door,
118         .select_speed           = sr_select_speed,
119         .get_last_session       = sr_get_last_session,
120         .get_mcn                = sr_get_mcn,
121         .reset                  = sr_reset,
122         .audio_ioctl            = sr_audio_ioctl,
123         .capability             = SR_CAPABILITIES,
124         .generic_packet         = sr_packet,
125 };
126
127 static void sr_kref_release(struct kref *kref);
128
129 static inline struct scsi_cd *scsi_cd(struct gendisk *disk)
130 {
131         return container_of(disk->private_data, struct scsi_cd, driver);
132 }
133
134 /*
135  * The get and put routines for the struct scsi_cd.  Note this entity
136  * has a scsi_device pointer and owns a reference to this.
137  */
138 static inline struct scsi_cd *scsi_cd_get(struct gendisk *disk)
139 {
140         struct scsi_cd *cd = NULL;
141
142         mutex_lock(&sr_ref_mutex);
143         if (disk->private_data == NULL)
144                 goto out;
145         cd = scsi_cd(disk);
146         kref_get(&cd->kref);
147         if (scsi_device_get(cd->device))
148                 goto out_put;
149         goto out;
150
151  out_put:
152         kref_put(&cd->kref, sr_kref_release);
153         cd = NULL;
154  out:
155         mutex_unlock(&sr_ref_mutex);
156         return cd;
157 }
158
159 static void scsi_cd_put(struct scsi_cd *cd)
160 {
161         struct scsi_device *sdev = cd->device;
162
163         mutex_lock(&sr_ref_mutex);
164         kref_put(&cd->kref, sr_kref_release);
165         scsi_device_put(sdev);
166         mutex_unlock(&sr_ref_mutex);
167 }
168
169 static unsigned int sr_get_events(struct scsi_device *sdev)
170 {
171         u8 buf[8];
172         u8 cmd[] = { GET_EVENT_STATUS_NOTIFICATION,
173                      1,                 /* polled */
174                      0, 0,              /* reserved */
175                      1 << 4,            /* notification class: media */
176                      0, 0,              /* reserved */
177                      0, sizeof(buf),    /* allocation length */
178                      0,                 /* control */
179         };
180         struct event_header *eh = (void *)buf;
181         struct media_event_desc *med = (void *)(buf + 4);
182         struct scsi_sense_hdr sshdr;
183         int result;
184
185         result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, sizeof(buf),
186                                   &sshdr, SR_TIMEOUT, MAX_RETRIES, NULL);
187         if (scsi_sense_valid(&sshdr) && sshdr.sense_key == UNIT_ATTENTION)
188                 return DISK_EVENT_MEDIA_CHANGE;
189
190         if (result || be16_to_cpu(eh->data_len) < sizeof(*med))
191                 return 0;
192
193         if (eh->nea || eh->notification_class != 0x4)
194                 return 0;
195
196         if (med->media_event_code == 1)
197                 return DISK_EVENT_EJECT_REQUEST;
198         else if (med->media_event_code == 2)
199                 return DISK_EVENT_MEDIA_CHANGE;
200         return 0;
201 }
202
203 /*
204  * This function checks to see if the media has been changed or eject
205  * button has been pressed.  It is possible that we have already
206  * sensed a change, or the drive may have sensed one and not yet
207  * reported it.  The past events are accumulated in sdev->changed and
208  * returned together with the current state.
209  */
210 static unsigned int sr_check_events(struct cdrom_device_info *cdi,
211                                     unsigned int clearing, int slot)
212 {
213         struct scsi_cd *cd = cdi->handle;
214         bool last_present;
215         struct scsi_sense_hdr sshdr;
216         unsigned int events;
217         int ret;
218
219         /* no changer support */
220         if (CDSL_CURRENT != slot)
221                 return 0;
222
223         events = sr_get_events(cd->device);
224         /*
225          * GET_EVENT_STATUS_NOTIFICATION is enough unless MEDIA_CHANGE
226          * is being cleared.  Note that there are devices which hang
227          * if asked to execute TUR repeatedly.
228          */
229         if (!(clearing & DISK_EVENT_MEDIA_CHANGE))
230                 goto skip_tur;
231
232         /* let's see whether the media is there with TUR */
233         last_present = cd->media_present;
234         ret = scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr);
235
236         /*
237          * Media is considered to be present if TUR succeeds or fails with
238          * sense data indicating something other than media-not-present
239          * (ASC 0x3a).
240          */
241         cd->media_present = scsi_status_is_good(ret) ||
242                 (scsi_sense_valid(&sshdr) && sshdr.asc != 0x3a);
243
244         if (last_present != cd->media_present)
245                 events |= DISK_EVENT_MEDIA_CHANGE;
246 skip_tur:
247         if (cd->device->changed) {
248                 events |= DISK_EVENT_MEDIA_CHANGE;
249                 cd->device->changed = 0;
250         }
251
252         return events;
253 }
254
255 /*
256  * sr_done is the interrupt routine for the device driver.
257  *
258  * It will be notified on the end of a SCSI read / write, and will take one
259  * of several actions based on success or failure.
260  */
261 static int sr_done(struct scsi_cmnd *SCpnt)
262 {
263         int result = SCpnt->result;
264         int this_count = scsi_bufflen(SCpnt);
265         int good_bytes = (result == 0 ? this_count : 0);
266         int block_sectors = 0;
267         long error_sector;
268         struct scsi_cd *cd = scsi_cd(SCpnt->request->rq_disk);
269
270 #ifdef DEBUG
271         printk("sr.c done: %x\n", result);
272 #endif
273
274         /*
275          * Handle MEDIUM ERRORs or VOLUME OVERFLOWs that indicate partial
276          * success.  Since this is a relatively rare error condition, no
277          * care is taken to avoid unnecessary additional work such as
278          * memcpy's that could be avoided.
279          */
280         if (driver_byte(result) != 0 &&         /* An error occurred */
281             (SCpnt->sense_buffer[0] & 0x7f) == 0x70) { /* Sense current */
282                 switch (SCpnt->sense_buffer[2]) {
283                 case MEDIUM_ERROR:
284                 case VOLUME_OVERFLOW:
285                 case ILLEGAL_REQUEST:
286                         if (!(SCpnt->sense_buffer[0] & 0x90))
287                                 break;
288                         error_sector = (SCpnt->sense_buffer[3] << 24) |
289                                 (SCpnt->sense_buffer[4] << 16) |
290                                 (SCpnt->sense_buffer[5] << 8) |
291                                 SCpnt->sense_buffer[6];
292                         if (SCpnt->request->bio != NULL)
293                                 block_sectors =
294                                         bio_sectors(SCpnt->request->bio);
295                         if (block_sectors < 4)
296                                 block_sectors = 4;
297                         if (cd->device->sector_size == 2048)
298                                 error_sector <<= 2;
299                         error_sector &= ~(block_sectors - 1);
300                         good_bytes = (error_sector -
301                                       blk_rq_pos(SCpnt->request)) << 9;
302                         if (good_bytes < 0 || good_bytes >= this_count)
303                                 good_bytes = 0;
304                         /*
305                          * The SCSI specification allows for the value
306                          * returned by READ CAPACITY to be up to 75 2K
307                          * sectors past the last readable block.
308                          * Therefore, if we hit a medium error within the
309                          * last 75 2K sectors, we decrease the saved size
310                          * value.
311                          */
312                         if (error_sector < get_capacity(cd->disk) &&
313                             cd->capacity - error_sector < 4 * 75)
314                                 set_capacity(cd->disk, error_sector);
315                         break;
316
317                 case RECOVERED_ERROR:
318                         good_bytes = this_count;
319                         break;
320
321                 default:
322                         break;
323                 }
324         }
325
326         return good_bytes;
327 }
328
329 static int sr_prep_fn(struct request_queue *q, struct request *rq)
330 {
331         int block = 0, this_count, s_size;
332         struct scsi_cd *cd;
333         struct scsi_cmnd *SCpnt;
334         struct scsi_device *sdp = q->queuedata;
335         int ret;
336
337         if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
338                 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
339                 goto out;
340         } else if (rq->cmd_type != REQ_TYPE_FS) {
341                 ret = BLKPREP_KILL;
342                 goto out;
343         }
344         ret = scsi_setup_fs_cmnd(sdp, rq);
345         if (ret != BLKPREP_OK)
346                 goto out;
347         SCpnt = rq->special;
348         cd = scsi_cd(rq->rq_disk);
349
350         /* from here on until we're complete, any goto out
351          * is used for a killable error condition */
352         ret = BLKPREP_KILL;
353
354         SCSI_LOG_HLQUEUE(1, printk("Doing sr request, dev = %s, block = %d\n",
355                                 cd->disk->disk_name, block));
356
357         if (!cd->device || !scsi_device_online(cd->device)) {
358                 SCSI_LOG_HLQUEUE(2, printk("Finishing %u sectors\n",
359                                            blk_rq_sectors(rq)));
360                 SCSI_LOG_HLQUEUE(2, printk("Retry with 0x%p\n", SCpnt));
361                 goto out;
362         }
363
364         if (cd->device->changed) {
365                 /*
366                  * quietly refuse to do anything to a changed disc until the
367                  * changed bit has been reset
368                  */
369                 goto out;
370         }
371
372         /*
373          * we do lazy blocksize switching (when reading XA sectors,
374          * see CDROMREADMODE2 ioctl) 
375          */
376         s_size = cd->device->sector_size;
377         if (s_size > 2048) {
378                 if (!in_interrupt())
379                         sr_set_blocklength(cd, 2048);
380                 else
381                         printk("sr: can't switch blocksize: in interrupt\n");
382         }
383
384         if (s_size != 512 && s_size != 1024 && s_size != 2048) {
385                 scmd_printk(KERN_ERR, SCpnt, "bad sector size %d\n", s_size);
386                 goto out;
387         }
388
389         if (rq_data_dir(rq) == WRITE) {
390                 if (!cd->device->writeable)
391                         goto out;
392                 SCpnt->cmnd[0] = WRITE_10;
393                 SCpnt->sc_data_direction = DMA_TO_DEVICE;
394                 cd->cdi.media_written = 1;
395         } else if (rq_data_dir(rq) == READ) {
396                 SCpnt->cmnd[0] = READ_10;
397                 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
398         } else {
399                 blk_dump_rq_flags(rq, "Unknown sr command");
400                 goto out;
401         }
402
403         {
404                 struct scatterlist *sg;
405                 int i, size = 0, sg_count = scsi_sg_count(SCpnt);
406
407                 scsi_for_each_sg(SCpnt, sg, sg_count, i)
408                         size += sg->length;
409
410                 if (size != scsi_bufflen(SCpnt)) {
411                         scmd_printk(KERN_ERR, SCpnt,
412                                 "mismatch count %d, bytes %d\n",
413                                 size, scsi_bufflen(SCpnt));
414                         if (scsi_bufflen(SCpnt) > size)
415                                 SCpnt->sdb.length = size;
416                 }
417         }
418
419         /*
420          * request doesn't start on hw block boundary, add scatter pads
421          */
422         if (((unsigned int)blk_rq_pos(rq) % (s_size >> 9)) ||
423             (scsi_bufflen(SCpnt) % s_size)) {
424                 scmd_printk(KERN_NOTICE, SCpnt, "unaligned transfer\n");
425                 goto out;
426         }
427
428         this_count = (scsi_bufflen(SCpnt) >> 9) / (s_size >> 9);
429
430
431         SCSI_LOG_HLQUEUE(2, printk("%s : %s %d/%u 512 byte blocks.\n",
432                                 cd->cdi.name,
433                                 (rq_data_dir(rq) == WRITE) ?
434                                         "writing" : "reading",
435                                 this_count, blk_rq_sectors(rq)));
436
437         SCpnt->cmnd[1] = 0;
438         block = (unsigned int)blk_rq_pos(rq) / (s_size >> 9);
439
440         if (this_count > 0xffff) {
441                 this_count = 0xffff;
442                 SCpnt->sdb.length = this_count * s_size;
443         }
444
445         SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
446         SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
447         SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
448         SCpnt->cmnd[5] = (unsigned char) block & 0xff;
449         SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
450         SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
451         SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
452
453         /*
454          * We shouldn't disconnect in the middle of a sector, so with a dumb
455          * host adapter, it's safe to assume that we can at least transfer
456          * this many bytes between each connect / disconnect.
457          */
458         SCpnt->transfersize = cd->device->sector_size;
459         SCpnt->underflow = this_count << 9;
460         SCpnt->allowed = MAX_RETRIES;
461
462         /*
463          * This indicates that the command is ready from our end to be
464          * queued.
465          */
466         ret = BLKPREP_OK;
467  out:
468         return scsi_prep_return(q, rq, ret);
469 }
470
471 static int sr_block_open(struct block_device *bdev, fmode_t mode)
472 {
473         struct scsi_cd *cd;
474         int ret = -ENXIO;
475
476         mutex_lock(&sr_mutex);
477         cd = scsi_cd_get(bdev->bd_disk);
478         if (cd) {
479                 ret = cdrom_open(&cd->cdi, bdev, mode);
480                 if (ret)
481                         scsi_cd_put(cd);
482         }
483         mutex_unlock(&sr_mutex);
484         return ret;
485 }
486
487 static int sr_block_release(struct gendisk *disk, fmode_t mode)
488 {
489         struct scsi_cd *cd = scsi_cd(disk);
490         mutex_lock(&sr_mutex);
491         cdrom_release(&cd->cdi, mode);
492         scsi_cd_put(cd);
493         mutex_unlock(&sr_mutex);
494         return 0;
495 }
496
497 static int sr_block_ioctl(struct block_device *bdev, fmode_t mode, unsigned cmd,
498                           unsigned long arg)
499 {
500         struct scsi_cd *cd = scsi_cd(bdev->bd_disk);
501         struct scsi_device *sdev = cd->device;
502         void __user *argp = (void __user *)arg;
503         int ret;
504
505         mutex_lock(&sr_mutex);
506
507         /*
508          * Send SCSI addressing ioctls directly to mid level, send other
509          * ioctls to cdrom/block level.
510          */
511         switch (cmd) {
512         case SCSI_IOCTL_GET_IDLUN:
513         case SCSI_IOCTL_GET_BUS_NUMBER:
514                 ret = scsi_ioctl(sdev, cmd, argp);
515                 goto out;
516         }
517
518         ret = cdrom_ioctl(&cd->cdi, bdev, mode, cmd, arg);
519         if (ret != -ENOSYS)
520                 goto out;
521
522         /*
523          * ENODEV means that we didn't recognise the ioctl, or that we
524          * cannot execute it in the current device state.  In either
525          * case fall through to scsi_ioctl, which will return ENDOEV again
526          * if it doesn't recognise the ioctl
527          */
528         ret = scsi_nonblockable_ioctl(sdev, cmd, argp,
529                                         (mode & FMODE_NDELAY) != 0);
530         if (ret != -ENODEV)
531                 goto out;
532         ret = scsi_ioctl(sdev, cmd, argp);
533
534 out:
535         mutex_unlock(&sr_mutex);
536         return ret;
537 }
538
539 static unsigned int sr_block_check_events(struct gendisk *disk,
540                                           unsigned int clearing)
541 {
542         struct scsi_cd *cd = scsi_cd(disk);
543         return cdrom_check_events(&cd->cdi, clearing);
544 }
545
546 static int sr_block_revalidate_disk(struct gendisk *disk)
547 {
548         struct scsi_cd *cd = scsi_cd(disk);
549         struct scsi_sense_hdr sshdr;
550
551         /* if the unit is not ready, nothing more to do */
552         if (scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr))
553                 return 0;
554
555         sr_cd_check(&cd->cdi);
556         get_sectorsize(cd);
557         return 0;
558 }
559
560 static const struct block_device_operations sr_bdops =
561 {
562         .owner          = THIS_MODULE,
563         .open           = sr_block_open,
564         .release        = sr_block_release,
565         .ioctl          = sr_block_ioctl,
566         .check_events   = sr_block_check_events,
567         .revalidate_disk = sr_block_revalidate_disk,
568         /* 
569          * No compat_ioctl for now because sr_block_ioctl never
570          * seems to pass arbitrary ioctls down to host drivers.
571          */
572 };
573
574 static int sr_open(struct cdrom_device_info *cdi, int purpose)
575 {
576         struct scsi_cd *cd = cdi->handle;
577         struct scsi_device *sdev = cd->device;
578         int retval;
579
580         /*
581          * If the device is in error recovery, wait until it is done.
582          * If the device is offline, then disallow any access to it.
583          */
584         retval = -ENXIO;
585         if (!scsi_block_when_processing_errors(sdev))
586                 goto error_out;
587
588         return 0;
589
590 error_out:
591         return retval;  
592 }
593
594 static void sr_release(struct cdrom_device_info *cdi)
595 {
596         struct scsi_cd *cd = cdi->handle;
597
598         if (cd->device->sector_size > 2048)
599                 sr_set_blocklength(cd, 2048);
600
601 }
602
603 static int sr_probe(struct device *dev)
604 {
605         struct scsi_device *sdev = to_scsi_device(dev);
606         struct gendisk *disk;
607         struct scsi_cd *cd;
608         int minor, error;
609
610         error = -ENODEV;
611         if (sdev->type != TYPE_ROM && sdev->type != TYPE_WORM)
612                 goto fail;
613
614         error = -ENOMEM;
615         cd = kzalloc(sizeof(*cd), GFP_KERNEL);
616         if (!cd)
617                 goto fail;
618
619         kref_init(&cd->kref);
620
621         disk = alloc_disk(1);
622         if (!disk)
623                 goto fail_free;
624
625         spin_lock(&sr_index_lock);
626         minor = find_first_zero_bit(sr_index_bits, SR_DISKS);
627         if (minor == SR_DISKS) {
628                 spin_unlock(&sr_index_lock);
629                 error = -EBUSY;
630                 goto fail_put;
631         }
632         __set_bit(minor, sr_index_bits);
633         spin_unlock(&sr_index_lock);
634
635         disk->major = SCSI_CDROM_MAJOR;
636         disk->first_minor = minor;
637         sprintf(disk->disk_name, "sr%d", minor);
638         disk->fops = &sr_bdops;
639         disk->flags = GENHD_FL_CD;
640         disk->events = DISK_EVENT_MEDIA_CHANGE | DISK_EVENT_EJECT_REQUEST;
641
642         blk_queue_rq_timeout(sdev->request_queue, SR_TIMEOUT);
643
644         cd->device = sdev;
645         cd->disk = disk;
646         cd->driver = &sr_template;
647         cd->disk = disk;
648         cd->capacity = 0x1fffff;
649         cd->device->changed = 1;        /* force recheck CD type */
650         cd->media_present = 1;
651         cd->use = 1;
652         cd->readcd_known = 0;
653         cd->readcd_cdda = 0;
654
655         cd->cdi.ops = &sr_dops;
656         cd->cdi.handle = cd;
657         cd->cdi.mask = 0;
658         cd->cdi.capacity = 1;
659         sprintf(cd->cdi.name, "sr%d", minor);
660
661         sdev->sector_size = 2048;       /* A guess, just in case */
662
663         /* FIXME: need to handle a get_capabilities failure properly ?? */
664         get_capabilities(cd);
665         blk_queue_prep_rq(sdev->request_queue, sr_prep_fn);
666         sr_vendor_init(cd);
667
668         disk->driverfs_dev = &sdev->sdev_gendev;
669         set_capacity(disk, cd->capacity);
670         disk->private_data = &cd->driver;
671         disk->queue = sdev->request_queue;
672         cd->cdi.disk = disk;
673
674         if (register_cdrom(&cd->cdi))
675                 goto fail_put;
676
677         dev_set_drvdata(dev, cd);
678         disk->flags |= GENHD_FL_REMOVABLE;
679         add_disk(disk);
680
681         sdev_printk(KERN_DEBUG, sdev,
682                     "Attached scsi CD-ROM %s\n", cd->cdi.name);
683         return 0;
684
685 fail_put:
686         put_disk(disk);
687 fail_free:
688         kfree(cd);
689 fail:
690         return error;
691 }
692
693
694 static void get_sectorsize(struct scsi_cd *cd)
695 {
696         unsigned char cmd[10];
697         unsigned char buffer[8];
698         int the_result, retries = 3;
699         int sector_size;
700         struct request_queue *queue;
701
702         do {
703                 cmd[0] = READ_CAPACITY;
704                 memset((void *) &cmd[1], 0, 9);
705                 memset(buffer, 0, sizeof(buffer));
706
707                 /* Do the command and wait.. */
708                 the_result = scsi_execute_req(cd->device, cmd, DMA_FROM_DEVICE,
709                                               buffer, sizeof(buffer), NULL,
710                                               SR_TIMEOUT, MAX_RETRIES, NULL);
711
712                 retries--;
713
714         } while (the_result && retries);
715
716
717         if (the_result) {
718                 cd->capacity = 0x1fffff;
719                 sector_size = 2048;     /* A guess, just in case */
720         } else {
721                 long last_written;
722
723                 cd->capacity = 1 + ((buffer[0] << 24) | (buffer[1] << 16) |
724                                     (buffer[2] << 8) | buffer[3]);
725                 /*
726                  * READ_CAPACITY doesn't return the correct size on
727                  * certain UDF media.  If last_written is larger, use
728                  * it instead.
729                  *
730                  * http://bugzilla.kernel.org/show_bug.cgi?id=9668
731                  */
732                 if (!cdrom_get_last_written(&cd->cdi, &last_written))
733                         cd->capacity = max_t(long, cd->capacity, last_written);
734
735                 sector_size = (buffer[4] << 24) |
736                     (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
737                 switch (sector_size) {
738                         /*
739                          * HP 4020i CD-Recorder reports 2340 byte sectors
740                          * Philips CD-Writers report 2352 byte sectors
741                          *
742                          * Use 2k sectors for them..
743                          */
744                 case 0:
745                 case 2340:
746                 case 2352:
747                         sector_size = 2048;
748                         /* fall through */
749                 case 2048:
750                         cd->capacity *= 4;
751                         /* fall through */
752                 case 512:
753                         break;
754                 default:
755                         printk("%s: unsupported sector size %d.\n",
756                                cd->cdi.name, sector_size);
757                         cd->capacity = 0;
758                 }
759
760                 cd->device->sector_size = sector_size;
761
762                 /*
763                  * Add this so that we have the ability to correctly gauge
764                  * what the device is capable of.
765                  */
766                 set_capacity(cd->disk, cd->capacity);
767         }
768
769         queue = cd->device->request_queue;
770         blk_queue_logical_block_size(queue, sector_size);
771
772         return;
773 }
774
775 static void get_capabilities(struct scsi_cd *cd)
776 {
777         unsigned char *buffer;
778         struct scsi_mode_data data;
779         struct scsi_sense_hdr sshdr;
780         int rc, n;
781
782         static const char *loadmech[] =
783         {
784                 "caddy",
785                 "tray",
786                 "pop-up",
787                 "",
788                 "changer",
789                 "cartridge changer",
790                 "",
791                 ""
792         };
793
794
795         /* allocate transfer buffer */
796         buffer = kmalloc(512, GFP_KERNEL | GFP_DMA);
797         if (!buffer) {
798                 printk(KERN_ERR "sr: out of memory.\n");
799                 return;
800         }
801
802         /* eat unit attentions */
803         scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr);
804
805         /* ask for mode page 0x2a */
806         rc = scsi_mode_sense(cd->device, 0, 0x2a, buffer, 128,
807                              SR_TIMEOUT, 3, &data, NULL);
808
809         if (!scsi_status_is_good(rc)) {
810                 /* failed, drive doesn't have capabilities mode page */
811                 cd->cdi.speed = 1;
812                 cd->cdi.mask |= (CDC_CD_R | CDC_CD_RW | CDC_DVD_R |
813                                  CDC_DVD | CDC_DVD_RAM |
814                                  CDC_SELECT_DISC | CDC_SELECT_SPEED |
815                                  CDC_MRW | CDC_MRW_W | CDC_RAM);
816                 kfree(buffer);
817                 printk("%s: scsi-1 drive\n", cd->cdi.name);
818                 return;
819         }
820
821         n = data.header_length + data.block_descriptor_length;
822         cd->cdi.speed = ((buffer[n + 8] << 8) + buffer[n + 9]) / 176;
823         cd->readcd_known = 1;
824         cd->readcd_cdda = buffer[n + 5] & 0x01;
825         /* print some capability bits */
826         printk("%s: scsi3-mmc drive: %dx/%dx %s%s%s%s%s%s\n", cd->cdi.name,
827                ((buffer[n + 14] << 8) + buffer[n + 15]) / 176,
828                cd->cdi.speed,
829                buffer[n + 3] & 0x01 ? "writer " : "", /* CD Writer */
830                buffer[n + 3] & 0x20 ? "dvd-ram " : "",
831                buffer[n + 2] & 0x02 ? "cd/rw " : "", /* can read rewriteable */
832                buffer[n + 4] & 0x20 ? "xa/form2 " : "", /* can read xa/from2 */
833                buffer[n + 5] & 0x01 ? "cdda " : "", /* can read audio data */
834                loadmech[buffer[n + 6] >> 5]);
835         if ((buffer[n + 6] >> 5) == 0)
836                 /* caddy drives can't close tray... */
837                 cd->cdi.mask |= CDC_CLOSE_TRAY;
838         if ((buffer[n + 2] & 0x8) == 0)
839                 /* not a DVD drive */
840                 cd->cdi.mask |= CDC_DVD;
841         if ((buffer[n + 3] & 0x20) == 0) 
842                 /* can't write DVD-RAM media */
843                 cd->cdi.mask |= CDC_DVD_RAM;
844         if ((buffer[n + 3] & 0x10) == 0)
845                 /* can't write DVD-R media */
846                 cd->cdi.mask |= CDC_DVD_R;
847         if ((buffer[n + 3] & 0x2) == 0)
848                 /* can't write CD-RW media */
849                 cd->cdi.mask |= CDC_CD_RW;
850         if ((buffer[n + 3] & 0x1) == 0)
851                 /* can't write CD-R media */
852                 cd->cdi.mask |= CDC_CD_R;
853         if ((buffer[n + 6] & 0x8) == 0)
854                 /* can't eject */
855                 cd->cdi.mask |= CDC_OPEN_TRAY;
856
857         if ((buffer[n + 6] >> 5) == mechtype_individual_changer ||
858             (buffer[n + 6] >> 5) == mechtype_cartridge_changer)
859                 cd->cdi.capacity =
860                     cdrom_number_of_slots(&cd->cdi);
861         if (cd->cdi.capacity <= 1)
862                 /* not a changer */
863                 cd->cdi.mask |= CDC_SELECT_DISC;
864         /*else    I don't think it can close its tray
865                 cd->cdi.mask |= CDC_CLOSE_TRAY; */
866
867         /*
868          * if DVD-RAM, MRW-W or CD-RW, we are randomly writable
869          */
870         if ((cd->cdi.mask & (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) !=
871                         (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) {
872                 cd->device->writeable = 1;
873         }
874
875         kfree(buffer);
876 }
877
878 /*
879  * sr_packet() is the entry point for the generic commands generated
880  * by the Uniform CD-ROM layer. 
881  */
882 static int sr_packet(struct cdrom_device_info *cdi,
883                 struct packet_command *cgc)
884 {
885         struct scsi_cd *cd = cdi->handle;
886         struct scsi_device *sdev = cd->device;
887
888         if (cgc->cmd[0] == GPCMD_READ_DISC_INFO && sdev->no_read_disc_info)
889                 return -EDRIVE_CANT_DO_THIS;
890
891         if (cgc->timeout <= 0)
892                 cgc->timeout = IOCTL_TIMEOUT;
893
894         sr_do_ioctl(cd, cgc);
895
896         return cgc->stat;
897 }
898
899 /**
900  *      sr_kref_release - Called to free the scsi_cd structure
901  *      @kref: pointer to embedded kref
902  *
903  *      sr_ref_mutex must be held entering this routine.  Because it is
904  *      called on last put, you should always use the scsi_cd_get()
905  *      scsi_cd_put() helpers which manipulate the semaphore directly
906  *      and never do a direct kref_put().
907  **/
908 static void sr_kref_release(struct kref *kref)
909 {
910         struct scsi_cd *cd = container_of(kref, struct scsi_cd, kref);
911         struct gendisk *disk = cd->disk;
912
913         spin_lock(&sr_index_lock);
914         clear_bit(MINOR(disk_devt(disk)), sr_index_bits);
915         spin_unlock(&sr_index_lock);
916
917         unregister_cdrom(&cd->cdi);
918
919         disk->private_data = NULL;
920
921         put_disk(disk);
922
923         kfree(cd);
924 }
925
926 static int sr_remove(struct device *dev)
927 {
928         struct scsi_cd *cd = dev_get_drvdata(dev);
929
930         blk_queue_prep_rq(cd->device->request_queue, scsi_prep_fn);
931         del_gendisk(cd->disk);
932
933         mutex_lock(&sr_ref_mutex);
934         kref_put(&cd->kref, sr_kref_release);
935         mutex_unlock(&sr_ref_mutex);
936
937         return 0;
938 }
939
940 static int __init init_sr(void)
941 {
942         int rc;
943
944         rc = register_blkdev(SCSI_CDROM_MAJOR, "sr");
945         if (rc)
946                 return rc;
947         rc = scsi_register_driver(&sr_template.gendrv);
948         if (rc)
949                 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
950
951         return rc;
952 }
953
954 static void __exit exit_sr(void)
955 {
956         scsi_unregister_driver(&sr_template.gendrv);
957         unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
958 }
959
960 module_init(init_sr);
961 module_exit(exit_sr);
962 MODULE_LICENSE("GPL");