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