Linux 4.9.237
[linux/fpc-iii.git] / drivers / scsi / sr.c
blob67a73ea0a615e90a0544eb8ef6656ab88c8cc56a
1 /*
2 * sr.c Copyright (C) 1992 David Giller
3 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
5 * adapted from:
6 * sd.c Copyright (C) 1992 Drew Eckhardt
7 * Linux scsi disk driver by
8 * Drew Eckhardt <drew@colorado.edu>
10 * Modified by Eric Youngdale ericy@andante.org to
11 * add scatter-gather, multiple outstanding request, and other
12 * enhancements.
14 * Modified by Eric Youngdale eric@andante.org to support loadable
15 * low-level scsi drivers.
17 * Modified by Thomas Quinot thomas@melchior.cuivre.fdn.fr to
18 * provide auto-eject.
20 * Modified by Gerd Knorr <kraxel@cs.tu-berlin.de> to support the
21 * generic cdrom interface
23 * Modified by Jens Axboe <axboe@suse.de> - Uniform sr_packet()
24 * interface, capabilities probe additions, ioctl cleanups, etc.
26 * Modified by Richard Gooch <rgooch@atnf.csiro.au> to support devfs
28 * Modified by Jens Axboe <axboe@suse.de> - support DVD-RAM
29 * transparently and lose the GHOST hack
31 * Modified by Arnaldo Carvalho de Melo <acme@conectiva.com.br>
32 * check resource allocation in sr_init and some cleanups
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 <linux/pm_runtime.h>
49 #include <asm/uaccess.h>
51 #include <scsi/scsi.h>
52 #include <scsi/scsi_dbg.h>
53 #include <scsi/scsi_device.h>
54 #include <scsi/scsi_driver.h>
55 #include <scsi/scsi_cmnd.h>
56 #include <scsi/scsi_eh.h>
57 #include <scsi/scsi_host.h>
58 #include <scsi/scsi_ioctl.h> /* For the door lock/unlock commands */
60 #include "scsi_logging.h"
61 #include "sr.h"
64 MODULE_DESCRIPTION("SCSI cdrom (sr) driver");
65 MODULE_LICENSE("GPL");
66 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_CDROM_MAJOR);
67 MODULE_ALIAS_SCSI_DEVICE(TYPE_ROM);
68 MODULE_ALIAS_SCSI_DEVICE(TYPE_WORM);
70 #define SR_DISKS 256
72 #define SR_CAPABILITIES \
73 (CDC_CLOSE_TRAY|CDC_OPEN_TRAY|CDC_LOCK|CDC_SELECT_SPEED| \
74 CDC_SELECT_DISC|CDC_MULTI_SESSION|CDC_MCN|CDC_MEDIA_CHANGED| \
75 CDC_PLAY_AUDIO|CDC_RESET|CDC_DRIVE_STATUS| \
76 CDC_CD_R|CDC_CD_RW|CDC_DVD|CDC_DVD_R|CDC_DVD_RAM|CDC_GENERIC_PACKET| \
77 CDC_MRW|CDC_MRW_W|CDC_RAM)
79 static DEFINE_MUTEX(sr_mutex);
80 static int sr_probe(struct device *);
81 static int sr_remove(struct device *);
82 static int sr_init_command(struct scsi_cmnd *SCpnt);
83 static int sr_done(struct scsi_cmnd *);
84 static int sr_runtime_suspend(struct device *dev);
86 static const struct dev_pm_ops sr_pm_ops = {
87 .runtime_suspend = sr_runtime_suspend,
90 static struct scsi_driver sr_template = {
91 .gendrv = {
92 .name = "sr",
93 .owner = THIS_MODULE,
94 .probe = sr_probe,
95 .remove = sr_remove,
96 .pm = &sr_pm_ops,
98 .init_command = sr_init_command,
99 .done = sr_done,
102 static unsigned long sr_index_bits[SR_DISKS / BITS_PER_LONG];
103 static DEFINE_SPINLOCK(sr_index_lock);
105 /* This semaphore is used to mediate the 0->1 reference get in the
106 * face of object destruction (i.e. we can't allow a get on an
107 * object after last put) */
108 static DEFINE_MUTEX(sr_ref_mutex);
110 static int sr_open(struct cdrom_device_info *, int);
111 static void sr_release(struct cdrom_device_info *);
113 static void get_sectorsize(struct scsi_cd *);
114 static void get_capabilities(struct scsi_cd *);
116 static unsigned int sr_check_events(struct cdrom_device_info *cdi,
117 unsigned int clearing, int slot);
118 static int sr_packet(struct cdrom_device_info *, struct packet_command *);
120 static struct cdrom_device_ops sr_dops = {
121 .open = sr_open,
122 .release = sr_release,
123 .drive_status = sr_drive_status,
124 .check_events = sr_check_events,
125 .tray_move = sr_tray_move,
126 .lock_door = sr_lock_door,
127 .select_speed = sr_select_speed,
128 .get_last_session = sr_get_last_session,
129 .get_mcn = sr_get_mcn,
130 .reset = sr_reset,
131 .audio_ioctl = sr_audio_ioctl,
132 .capability = SR_CAPABILITIES,
133 .generic_packet = sr_packet,
136 static void sr_kref_release(struct kref *kref);
138 static inline struct scsi_cd *scsi_cd(struct gendisk *disk)
140 return container_of(disk->private_data, struct scsi_cd, driver);
143 static int sr_runtime_suspend(struct device *dev)
145 struct scsi_cd *cd = dev_get_drvdata(dev);
147 if (!cd) /* E.g.: runtime suspend following sr_remove() */
148 return 0;
150 if (cd->media_present)
151 return -EBUSY;
152 else
153 return 0;
157 * The get and put routines for the struct scsi_cd. Note this entity
158 * has a scsi_device pointer and owns a reference to this.
160 static inline struct scsi_cd *scsi_cd_get(struct gendisk *disk)
162 struct scsi_cd *cd = NULL;
164 mutex_lock(&sr_ref_mutex);
165 if (disk->private_data == NULL)
166 goto out;
167 cd = scsi_cd(disk);
168 kref_get(&cd->kref);
169 if (scsi_device_get(cd->device)) {
170 kref_put(&cd->kref, sr_kref_release);
171 cd = NULL;
173 out:
174 mutex_unlock(&sr_ref_mutex);
175 return cd;
178 static void scsi_cd_put(struct scsi_cd *cd)
180 struct scsi_device *sdev = cd->device;
182 mutex_lock(&sr_ref_mutex);
183 kref_put(&cd->kref, sr_kref_release);
184 scsi_device_put(sdev);
185 mutex_unlock(&sr_ref_mutex);
188 static unsigned int sr_get_events(struct scsi_device *sdev)
190 u8 buf[8];
191 u8 cmd[] = { GET_EVENT_STATUS_NOTIFICATION,
192 1, /* polled */
193 0, 0, /* reserved */
194 1 << 4, /* notification class: media */
195 0, 0, /* reserved */
196 0, sizeof(buf), /* allocation length */
197 0, /* control */
199 struct event_header *eh = (void *)buf;
200 struct media_event_desc *med = (void *)(buf + 4);
201 struct scsi_sense_hdr sshdr;
202 int result;
204 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, sizeof(buf),
205 &sshdr, SR_TIMEOUT, MAX_RETRIES, NULL);
206 if (scsi_sense_valid(&sshdr) && sshdr.sense_key == UNIT_ATTENTION)
207 return DISK_EVENT_MEDIA_CHANGE;
209 if (result || be16_to_cpu(eh->data_len) < sizeof(*med))
210 return 0;
212 if (eh->nea || eh->notification_class != 0x4)
213 return 0;
215 if (med->media_event_code == 1)
216 return DISK_EVENT_EJECT_REQUEST;
217 else if (med->media_event_code == 2)
218 return DISK_EVENT_MEDIA_CHANGE;
219 return 0;
223 * This function checks to see if the media has been changed or eject
224 * button has been pressed. It is possible that we have already
225 * sensed a change, or the drive may have sensed one and not yet
226 * reported it. The past events are accumulated in sdev->changed and
227 * returned together with the current state.
229 static unsigned int sr_check_events(struct cdrom_device_info *cdi,
230 unsigned int clearing, int slot)
232 struct scsi_cd *cd = cdi->handle;
233 bool last_present;
234 struct scsi_sense_hdr sshdr;
235 unsigned int events;
236 int ret;
238 /* no changer support */
239 if (CDSL_CURRENT != slot)
240 return 0;
242 events = sr_get_events(cd->device);
243 cd->get_event_changed |= events & DISK_EVENT_MEDIA_CHANGE;
246 * If earlier GET_EVENT_STATUS_NOTIFICATION and TUR did not agree
247 * for several times in a row. We rely on TUR only for this likely
248 * broken device, to prevent generating incorrect media changed
249 * events for every open().
251 if (cd->ignore_get_event) {
252 events &= ~DISK_EVENT_MEDIA_CHANGE;
253 goto do_tur;
257 * GET_EVENT_STATUS_NOTIFICATION is enough unless MEDIA_CHANGE
258 * is being cleared. Note that there are devices which hang
259 * if asked to execute TUR repeatedly.
261 if (cd->device->changed) {
262 events |= DISK_EVENT_MEDIA_CHANGE;
263 cd->device->changed = 0;
264 cd->tur_changed = true;
267 if (!(clearing & DISK_EVENT_MEDIA_CHANGE))
268 return events;
269 do_tur:
270 /* let's see whether the media is there with TUR */
271 last_present = cd->media_present;
272 ret = scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr);
275 * Media is considered to be present if TUR succeeds or fails with
276 * sense data indicating something other than media-not-present
277 * (ASC 0x3a).
279 cd->media_present = scsi_status_is_good(ret) ||
280 (scsi_sense_valid(&sshdr) && sshdr.asc != 0x3a);
282 if (last_present != cd->media_present)
283 cd->device->changed = 1;
285 if (cd->device->changed) {
286 events |= DISK_EVENT_MEDIA_CHANGE;
287 cd->device->changed = 0;
288 cd->tur_changed = true;
291 if (cd->ignore_get_event)
292 return events;
294 /* check whether GET_EVENT is reporting spurious MEDIA_CHANGE */
295 if (!cd->tur_changed) {
296 if (cd->get_event_changed) {
297 if (cd->tur_mismatch++ > 8) {
298 sr_printk(KERN_WARNING, cd,
299 "GET_EVENT and TUR disagree continuously, suppress GET_EVENT events\n");
300 cd->ignore_get_event = true;
302 } else {
303 cd->tur_mismatch = 0;
306 cd->tur_changed = false;
307 cd->get_event_changed = false;
309 return events;
313 * sr_done is the interrupt routine for the device driver.
315 * It will be notified on the end of a SCSI read / write, and will take one
316 * of several actions based on success or failure.
318 static int sr_done(struct scsi_cmnd *SCpnt)
320 int result = SCpnt->result;
321 int this_count = scsi_bufflen(SCpnt);
322 int good_bytes = (result == 0 ? this_count : 0);
323 int block_sectors = 0;
324 long error_sector;
325 struct scsi_cd *cd = scsi_cd(SCpnt->request->rq_disk);
327 #ifdef DEBUG
328 scmd_printk(KERN_INFO, SCpnt, "done: %x\n", result);
329 #endif
332 * Handle MEDIUM ERRORs or VOLUME OVERFLOWs that indicate partial
333 * success. Since this is a relatively rare error condition, no
334 * care is taken to avoid unnecessary additional work such as
335 * memcpy's that could be avoided.
337 if (driver_byte(result) != 0 && /* An error occurred */
338 (SCpnt->sense_buffer[0] & 0x7f) == 0x70) { /* Sense current */
339 switch (SCpnt->sense_buffer[2]) {
340 case MEDIUM_ERROR:
341 case VOLUME_OVERFLOW:
342 case ILLEGAL_REQUEST:
343 if (!(SCpnt->sense_buffer[0] & 0x90))
344 break;
345 error_sector = (SCpnt->sense_buffer[3] << 24) |
346 (SCpnt->sense_buffer[4] << 16) |
347 (SCpnt->sense_buffer[5] << 8) |
348 SCpnt->sense_buffer[6];
349 if (SCpnt->request->bio != NULL)
350 block_sectors =
351 bio_sectors(SCpnt->request->bio);
352 if (block_sectors < 4)
353 block_sectors = 4;
354 if (cd->device->sector_size == 2048)
355 error_sector <<= 2;
356 error_sector &= ~(block_sectors - 1);
357 good_bytes = (error_sector -
358 blk_rq_pos(SCpnt->request)) << 9;
359 if (good_bytes < 0 || good_bytes >= this_count)
360 good_bytes = 0;
362 * The SCSI specification allows for the value
363 * returned by READ CAPACITY to be up to 75 2K
364 * sectors past the last readable block.
365 * Therefore, if we hit a medium error within the
366 * last 75 2K sectors, we decrease the saved size
367 * value.
369 if (error_sector < get_capacity(cd->disk) &&
370 cd->capacity - error_sector < 4 * 75)
371 set_capacity(cd->disk, error_sector);
372 break;
374 case RECOVERED_ERROR:
375 good_bytes = this_count;
376 break;
378 default:
379 break;
383 return good_bytes;
386 static int sr_init_command(struct scsi_cmnd *SCpnt)
388 int block = 0, this_count, s_size;
389 struct scsi_cd *cd;
390 struct request *rq = SCpnt->request;
391 int ret;
393 ret = scsi_init_io(SCpnt);
394 if (ret != BLKPREP_OK)
395 goto out;
396 SCpnt = rq->special;
397 cd = scsi_cd(rq->rq_disk);
399 /* from here on until we're complete, any goto out
400 * is used for a killable error condition */
401 ret = BLKPREP_KILL;
403 SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
404 "Doing sr request, block = %d\n", block));
406 if (!cd->device || !scsi_device_online(cd->device)) {
407 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
408 "Finishing %u sectors\n", blk_rq_sectors(rq)));
409 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
410 "Retry with 0x%p\n", SCpnt));
411 goto out;
414 if (cd->device->changed) {
416 * quietly refuse to do anything to a changed disc until the
417 * changed bit has been reset
419 goto out;
423 * we do lazy blocksize switching (when reading XA sectors,
424 * see CDROMREADMODE2 ioctl)
426 s_size = cd->device->sector_size;
427 if (s_size > 2048) {
428 if (!in_interrupt())
429 sr_set_blocklength(cd, 2048);
430 else
431 scmd_printk(KERN_INFO, SCpnt,
432 "can't switch blocksize: in interrupt\n");
435 if (s_size != 512 && s_size != 1024 && s_size != 2048) {
436 scmd_printk(KERN_ERR, SCpnt, "bad sector size %d\n", s_size);
437 goto out;
440 if (rq_data_dir(rq) == WRITE) {
441 if (!cd->writeable)
442 goto out;
443 SCpnt->cmnd[0] = WRITE_10;
444 cd->cdi.media_written = 1;
445 } else if (rq_data_dir(rq) == READ) {
446 SCpnt->cmnd[0] = READ_10;
447 } else {
448 blk_dump_rq_flags(rq, "Unknown sr command");
449 goto out;
453 struct scatterlist *sg;
454 int i, size = 0, sg_count = scsi_sg_count(SCpnt);
456 scsi_for_each_sg(SCpnt, sg, sg_count, i)
457 size += sg->length;
459 if (size != scsi_bufflen(SCpnt)) {
460 scmd_printk(KERN_ERR, SCpnt,
461 "mismatch count %d, bytes %d\n",
462 size, scsi_bufflen(SCpnt));
463 if (scsi_bufflen(SCpnt) > size)
464 SCpnt->sdb.length = size;
469 * request doesn't start on hw block boundary, add scatter pads
471 if (((unsigned int)blk_rq_pos(rq) % (s_size >> 9)) ||
472 (scsi_bufflen(SCpnt) % s_size)) {
473 scmd_printk(KERN_NOTICE, SCpnt, "unaligned transfer\n");
474 goto out;
477 this_count = (scsi_bufflen(SCpnt) >> 9) / (s_size >> 9);
480 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
481 "%s %d/%u 512 byte blocks.\n",
482 (rq_data_dir(rq) == WRITE) ?
483 "writing" : "reading",
484 this_count, blk_rq_sectors(rq)));
486 SCpnt->cmnd[1] = 0;
487 block = (unsigned int)blk_rq_pos(rq) / (s_size >> 9);
489 if (this_count > 0xffff) {
490 this_count = 0xffff;
491 SCpnt->sdb.length = this_count * s_size;
494 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
495 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
496 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
497 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
498 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
499 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
500 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
503 * We shouldn't disconnect in the middle of a sector, so with a dumb
504 * host adapter, it's safe to assume that we can at least transfer
505 * this many bytes between each connect / disconnect.
507 SCpnt->transfersize = cd->device->sector_size;
508 SCpnt->underflow = this_count << 9;
509 SCpnt->allowed = MAX_RETRIES;
512 * This indicates that the command is ready from our end to be
513 * queued.
515 ret = BLKPREP_OK;
516 out:
517 return ret;
520 static int sr_block_open(struct block_device *bdev, fmode_t mode)
522 struct scsi_cd *cd;
523 struct scsi_device *sdev;
524 int ret = -ENXIO;
526 cd = scsi_cd_get(bdev->bd_disk);
527 if (!cd)
528 goto out;
530 sdev = cd->device;
531 scsi_autopm_get_device(sdev);
532 check_disk_change(bdev);
534 mutex_lock(&sr_mutex);
535 ret = cdrom_open(&cd->cdi, bdev, mode);
536 mutex_unlock(&sr_mutex);
538 scsi_autopm_put_device(sdev);
539 if (ret)
540 scsi_cd_put(cd);
542 out:
543 return ret;
546 static void sr_block_release(struct gendisk *disk, fmode_t mode)
548 struct scsi_cd *cd = scsi_cd(disk);
549 mutex_lock(&sr_mutex);
550 cdrom_release(&cd->cdi, mode);
551 scsi_cd_put(cd);
552 mutex_unlock(&sr_mutex);
555 static int sr_block_ioctl(struct block_device *bdev, fmode_t mode, unsigned cmd,
556 unsigned long arg)
558 struct scsi_cd *cd = scsi_cd(bdev->bd_disk);
559 struct scsi_device *sdev = cd->device;
560 void __user *argp = (void __user *)arg;
561 int ret;
563 mutex_lock(&sr_mutex);
565 ret = scsi_ioctl_block_when_processing_errors(sdev, cmd,
566 (mode & FMODE_NDELAY) != 0);
567 if (ret)
568 goto out;
570 scsi_autopm_get_device(sdev);
573 * Send SCSI addressing ioctls directly to mid level, send other
574 * ioctls to cdrom/block level.
576 switch (cmd) {
577 case SCSI_IOCTL_GET_IDLUN:
578 case SCSI_IOCTL_GET_BUS_NUMBER:
579 ret = scsi_ioctl(sdev, cmd, argp);
580 goto put;
583 ret = cdrom_ioctl(&cd->cdi, bdev, mode, cmd, arg);
584 if (ret != -ENOSYS)
585 goto put;
587 ret = scsi_ioctl(sdev, cmd, argp);
589 put:
590 scsi_autopm_put_device(sdev);
592 out:
593 mutex_unlock(&sr_mutex);
594 return ret;
597 static unsigned int sr_block_check_events(struct gendisk *disk,
598 unsigned int clearing)
600 unsigned int ret = 0;
601 struct scsi_cd *cd;
603 cd = scsi_cd_get(disk);
604 if (!cd)
605 return 0;
607 if (!atomic_read(&cd->device->disk_events_disable_depth))
608 ret = cdrom_check_events(&cd->cdi, clearing);
610 scsi_cd_put(cd);
611 return ret;
614 static int sr_block_revalidate_disk(struct gendisk *disk)
616 struct scsi_sense_hdr sshdr;
617 struct scsi_cd *cd;
619 cd = scsi_cd_get(disk);
620 if (!cd)
621 return -ENXIO;
623 /* if the unit is not ready, nothing more to do */
624 if (scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr))
625 goto out;
627 sr_cd_check(&cd->cdi);
628 get_sectorsize(cd);
629 out:
630 scsi_cd_put(cd);
631 return 0;
634 static const struct block_device_operations sr_bdops =
636 .owner = THIS_MODULE,
637 .open = sr_block_open,
638 .release = sr_block_release,
639 .ioctl = sr_block_ioctl,
640 .check_events = sr_block_check_events,
641 .revalidate_disk = sr_block_revalidate_disk,
643 * No compat_ioctl for now because sr_block_ioctl never
644 * seems to pass arbitrary ioctls down to host drivers.
648 static int sr_open(struct cdrom_device_info *cdi, int purpose)
650 struct scsi_cd *cd = cdi->handle;
651 struct scsi_device *sdev = cd->device;
652 int retval;
655 * If the device is in error recovery, wait until it is done.
656 * If the device is offline, then disallow any access to it.
658 retval = -ENXIO;
659 if (!scsi_block_when_processing_errors(sdev))
660 goto error_out;
662 return 0;
664 error_out:
665 return retval;
668 static void sr_release(struct cdrom_device_info *cdi)
670 struct scsi_cd *cd = cdi->handle;
672 if (cd->device->sector_size > 2048)
673 sr_set_blocklength(cd, 2048);
677 static int sr_probe(struct device *dev)
679 struct scsi_device *sdev = to_scsi_device(dev);
680 struct gendisk *disk;
681 struct scsi_cd *cd;
682 int minor, error;
684 scsi_autopm_get_device(sdev);
685 error = -ENODEV;
686 if (sdev->type != TYPE_ROM && sdev->type != TYPE_WORM)
687 goto fail;
689 error = -ENOMEM;
690 cd = kzalloc(sizeof(*cd), GFP_KERNEL);
691 if (!cd)
692 goto fail;
694 kref_init(&cd->kref);
696 disk = alloc_disk(1);
697 if (!disk)
698 goto fail_free;
700 spin_lock(&sr_index_lock);
701 minor = find_first_zero_bit(sr_index_bits, SR_DISKS);
702 if (minor == SR_DISKS) {
703 spin_unlock(&sr_index_lock);
704 error = -EBUSY;
705 goto fail_put;
707 __set_bit(minor, sr_index_bits);
708 spin_unlock(&sr_index_lock);
710 disk->major = SCSI_CDROM_MAJOR;
711 disk->first_minor = minor;
712 sprintf(disk->disk_name, "sr%d", minor);
713 disk->fops = &sr_bdops;
714 disk->flags = GENHD_FL_CD | GENHD_FL_BLOCK_EVENTS_ON_EXCL_WRITE;
715 disk->events = DISK_EVENT_MEDIA_CHANGE | DISK_EVENT_EJECT_REQUEST;
717 blk_queue_rq_timeout(sdev->request_queue, SR_TIMEOUT);
719 cd->device = sdev;
720 cd->disk = disk;
721 cd->driver = &sr_template;
722 cd->disk = disk;
723 cd->capacity = 0x1fffff;
724 cd->device->changed = 1; /* force recheck CD type */
725 cd->media_present = 1;
726 cd->use = 1;
727 cd->readcd_known = 0;
728 cd->readcd_cdda = 0;
730 cd->cdi.ops = &sr_dops;
731 cd->cdi.handle = cd;
732 cd->cdi.mask = 0;
733 cd->cdi.capacity = 1;
734 sprintf(cd->cdi.name, "sr%d", minor);
736 sdev->sector_size = 2048; /* A guess, just in case */
738 /* FIXME: need to handle a get_capabilities failure properly ?? */
739 get_capabilities(cd);
740 sr_vendor_init(cd);
742 set_capacity(disk, cd->capacity);
743 disk->private_data = &cd->driver;
744 disk->queue = sdev->request_queue;
745 cd->cdi.disk = disk;
747 if (register_cdrom(&cd->cdi))
748 goto fail_minor;
751 * Initialize block layer runtime PM stuffs before the
752 * periodic event checking request gets started in add_disk.
754 blk_pm_runtime_init(sdev->request_queue, dev);
756 dev_set_drvdata(dev, cd);
757 disk->flags |= GENHD_FL_REMOVABLE;
758 device_add_disk(&sdev->sdev_gendev, disk);
760 sdev_printk(KERN_DEBUG, sdev,
761 "Attached scsi CD-ROM %s\n", cd->cdi.name);
762 scsi_autopm_put_device(cd->device);
764 return 0;
766 fail_minor:
767 spin_lock(&sr_index_lock);
768 clear_bit(minor, sr_index_bits);
769 spin_unlock(&sr_index_lock);
770 fail_put:
771 put_disk(disk);
772 fail_free:
773 kfree(cd);
774 fail:
775 scsi_autopm_put_device(sdev);
776 return error;
780 static void get_sectorsize(struct scsi_cd *cd)
782 unsigned char cmd[10];
783 unsigned char buffer[8];
784 int the_result, retries = 3;
785 int sector_size;
786 struct request_queue *queue;
788 do {
789 cmd[0] = READ_CAPACITY;
790 memset((void *) &cmd[1], 0, 9);
791 memset(buffer, 0, sizeof(buffer));
793 /* Do the command and wait.. */
794 the_result = scsi_execute_req(cd->device, cmd, DMA_FROM_DEVICE,
795 buffer, sizeof(buffer), NULL,
796 SR_TIMEOUT, MAX_RETRIES, NULL);
798 retries--;
800 } while (the_result && retries);
803 if (the_result) {
804 cd->capacity = 0x1fffff;
805 sector_size = 2048; /* A guess, just in case */
806 } else {
807 long last_written;
809 cd->capacity = 1 + ((buffer[0] << 24) | (buffer[1] << 16) |
810 (buffer[2] << 8) | buffer[3]);
812 * READ_CAPACITY doesn't return the correct size on
813 * certain UDF media. If last_written is larger, use
814 * it instead.
816 * http://bugzilla.kernel.org/show_bug.cgi?id=9668
818 if (!cdrom_get_last_written(&cd->cdi, &last_written))
819 cd->capacity = max_t(long, cd->capacity, last_written);
821 sector_size = (buffer[4] << 24) |
822 (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
823 switch (sector_size) {
825 * HP 4020i CD-Recorder reports 2340 byte sectors
826 * Philips CD-Writers report 2352 byte sectors
828 * Use 2k sectors for them..
830 case 0:
831 case 2340:
832 case 2352:
833 sector_size = 2048;
834 /* fall through */
835 case 2048:
836 cd->capacity *= 4;
837 /* fall through */
838 case 512:
839 break;
840 default:
841 sr_printk(KERN_INFO, cd,
842 "unsupported sector size %d.", sector_size);
843 cd->capacity = 0;
846 cd->device->sector_size = sector_size;
849 * Add this so that we have the ability to correctly gauge
850 * what the device is capable of.
852 set_capacity(cd->disk, cd->capacity);
855 queue = cd->device->request_queue;
856 blk_queue_logical_block_size(queue, sector_size);
858 return;
861 static void get_capabilities(struct scsi_cd *cd)
863 unsigned char *buffer;
864 struct scsi_mode_data data;
865 struct scsi_sense_hdr sshdr;
866 unsigned int ms_len = 128;
867 int rc, n;
869 static const char *loadmech[] =
871 "caddy",
872 "tray",
873 "pop-up",
875 "changer",
876 "cartridge changer",
882 /* allocate transfer buffer */
883 buffer = kmalloc(512, GFP_KERNEL | GFP_DMA);
884 if (!buffer) {
885 sr_printk(KERN_ERR, cd, "out of memory.\n");
886 return;
889 /* eat unit attentions */
890 scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr);
892 /* ask for mode page 0x2a */
893 rc = scsi_mode_sense(cd->device, 0, 0x2a, buffer, ms_len,
894 SR_TIMEOUT, 3, &data, NULL);
896 if (!scsi_status_is_good(rc) || data.length > ms_len ||
897 data.header_length + data.block_descriptor_length > data.length) {
898 /* failed, drive doesn't have capabilities mode page */
899 cd->cdi.speed = 1;
900 cd->cdi.mask |= (CDC_CD_R | CDC_CD_RW | CDC_DVD_R |
901 CDC_DVD | CDC_DVD_RAM |
902 CDC_SELECT_DISC | CDC_SELECT_SPEED |
903 CDC_MRW | CDC_MRW_W | CDC_RAM);
904 kfree(buffer);
905 sr_printk(KERN_INFO, cd, "scsi-1 drive");
906 return;
909 n = data.header_length + data.block_descriptor_length;
910 cd->cdi.speed = ((buffer[n + 8] << 8) + buffer[n + 9]) / 176;
911 cd->readcd_known = 1;
912 cd->readcd_cdda = buffer[n + 5] & 0x01;
913 /* print some capability bits */
914 sr_printk(KERN_INFO, cd,
915 "scsi3-mmc drive: %dx/%dx %s%s%s%s%s%s\n",
916 ((buffer[n + 14] << 8) + buffer[n + 15]) / 176,
917 cd->cdi.speed,
918 buffer[n + 3] & 0x01 ? "writer " : "", /* CD Writer */
919 buffer[n + 3] & 0x20 ? "dvd-ram " : "",
920 buffer[n + 2] & 0x02 ? "cd/rw " : "", /* can read rewriteable */
921 buffer[n + 4] & 0x20 ? "xa/form2 " : "", /* can read xa/from2 */
922 buffer[n + 5] & 0x01 ? "cdda " : "", /* can read audio data */
923 loadmech[buffer[n + 6] >> 5]);
924 if ((buffer[n + 6] >> 5) == 0)
925 /* caddy drives can't close tray... */
926 cd->cdi.mask |= CDC_CLOSE_TRAY;
927 if ((buffer[n + 2] & 0x8) == 0)
928 /* not a DVD drive */
929 cd->cdi.mask |= CDC_DVD;
930 if ((buffer[n + 3] & 0x20) == 0)
931 /* can't write DVD-RAM media */
932 cd->cdi.mask |= CDC_DVD_RAM;
933 if ((buffer[n + 3] & 0x10) == 0)
934 /* can't write DVD-R media */
935 cd->cdi.mask |= CDC_DVD_R;
936 if ((buffer[n + 3] & 0x2) == 0)
937 /* can't write CD-RW media */
938 cd->cdi.mask |= CDC_CD_RW;
939 if ((buffer[n + 3] & 0x1) == 0)
940 /* can't write CD-R media */
941 cd->cdi.mask |= CDC_CD_R;
942 if ((buffer[n + 6] & 0x8) == 0)
943 /* can't eject */
944 cd->cdi.mask |= CDC_OPEN_TRAY;
946 if ((buffer[n + 6] >> 5) == mechtype_individual_changer ||
947 (buffer[n + 6] >> 5) == mechtype_cartridge_changer)
948 cd->cdi.capacity =
949 cdrom_number_of_slots(&cd->cdi);
950 if (cd->cdi.capacity <= 1)
951 /* not a changer */
952 cd->cdi.mask |= CDC_SELECT_DISC;
953 /*else I don't think it can close its tray
954 cd->cdi.mask |= CDC_CLOSE_TRAY; */
957 * if DVD-RAM, MRW-W or CD-RW, we are randomly writable
959 if ((cd->cdi.mask & (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) !=
960 (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) {
961 cd->writeable = 1;
964 kfree(buffer);
968 * sr_packet() is the entry point for the generic commands generated
969 * by the Uniform CD-ROM layer.
971 static int sr_packet(struct cdrom_device_info *cdi,
972 struct packet_command *cgc)
974 struct scsi_cd *cd = cdi->handle;
975 struct scsi_device *sdev = cd->device;
977 if (cgc->cmd[0] == GPCMD_READ_DISC_INFO && sdev->no_read_disc_info)
978 return -EDRIVE_CANT_DO_THIS;
980 if (cgc->timeout <= 0)
981 cgc->timeout = IOCTL_TIMEOUT;
983 sr_do_ioctl(cd, cgc);
985 return cgc->stat;
989 * sr_kref_release - Called to free the scsi_cd structure
990 * @kref: pointer to embedded kref
992 * sr_ref_mutex must be held entering this routine. Because it is
993 * called on last put, you should always use the scsi_cd_get()
994 * scsi_cd_put() helpers which manipulate the semaphore directly
995 * and never do a direct kref_put().
997 static void sr_kref_release(struct kref *kref)
999 struct scsi_cd *cd = container_of(kref, struct scsi_cd, kref);
1000 struct gendisk *disk = cd->disk;
1002 spin_lock(&sr_index_lock);
1003 clear_bit(MINOR(disk_devt(disk)), sr_index_bits);
1004 spin_unlock(&sr_index_lock);
1006 unregister_cdrom(&cd->cdi);
1008 disk->private_data = NULL;
1010 put_disk(disk);
1012 kfree(cd);
1015 static int sr_remove(struct device *dev)
1017 struct scsi_cd *cd = dev_get_drvdata(dev);
1019 scsi_autopm_get_device(cd->device);
1021 del_gendisk(cd->disk);
1022 dev_set_drvdata(dev, NULL);
1024 mutex_lock(&sr_ref_mutex);
1025 kref_put(&cd->kref, sr_kref_release);
1026 mutex_unlock(&sr_ref_mutex);
1028 return 0;
1031 static int __init init_sr(void)
1033 int rc;
1035 rc = register_blkdev(SCSI_CDROM_MAJOR, "sr");
1036 if (rc)
1037 return rc;
1038 rc = scsi_register_driver(&sr_template.gendrv);
1039 if (rc)
1040 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
1042 return rc;
1045 static void __exit exit_sr(void)
1047 scsi_unregister_driver(&sr_template.gendrv);
1048 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
1051 module_init(init_sr);
1052 module_exit(exit_sr);
1053 MODULE_LICENSE("GPL");