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