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