drivers/scsi/sr.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  sr.c Copyright (C) 1992 David Giller
   4  *           Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
   5  *
   6  *  adapted from:
   7  *      sd.c Copyright (C) 1992 Drew Eckhardt
   8  *      Linux scsi disk driver by
   9  *              Drew Eckhardt <drew@colorado.edu>
  10  *
  11  *      Modified by Eric Youngdale ericy@andante.org to
  12  *      add scatter-gather, multiple outstanding request, and other
  13  *      enhancements.
  14  *
  15  *      Modified by Eric Youngdale eric@andante.org to support loadable
  16  *      low-level scsi drivers.
  17  *
  18  *      Modified by Thomas Quinot thomas@melchior.cuivre.fdn.fr to
  19  *      provide auto-eject.
  20  *
  21  *      Modified by Gerd Knorr <kraxel@cs.tu-berlin.de> to support the
  22  *      generic cdrom interface
  23  *
  24  *      Modified by Jens Axboe <axboe@suse.de> - Uniform sr_packet()
  25  *      interface, capabilities probe additions, ioctl cleanups, etc.
  26  *
  27  *      Modified by Richard Gooch <rgooch@atnf.csiro.au> to support devfs
  28  *
  29  *      Modified by Jens Axboe <axboe@suse.de> - support DVD-RAM
  30  *      transparently and lose the GHOST hack
  31  *
  32  *      Modified by Arnaldo Carvalho de Melo <acme@conectiva.com.br>
  33  *      check resource allocation in sr_init and some cleanups
  34  */
  35
  36 #include <linux/module.h>
  37 #include <linux/fs.h>
  38 #include <linux/kernel.h>
  39 #include <linux/mm.h>
  40 #include <linux/bio.h>
  41 #include <linux/compat.h>
  42 #include <linux/string.h>
  43 #include <linux/errno.h>
  44 #include <linux/cdrom.h>
  45 #include <linux/interrupt.h>
  46 #include <linux/init.h>
  47 #include <linux/blkdev.h>
  48 #include <linux/blk-pm.h>
  49 #include <linux/mutex.h>
  50 #include <linux/slab.h>
  51 #include <linux/pm_runtime.h>
  52 #include <linux/uaccess.h>
  53
  54 #include <scsi/scsi.h>
  55 #include <scsi/scsi_dbg.h>
  56 #include <scsi/scsi_device.h>
  57 #include <scsi/scsi_driver.h>
  58 #include <scsi/scsi_cmnd.h>
  59 #include <scsi/scsi_eh.h>
  60 #include <scsi/scsi_host.h>
  61 #include <scsi/scsi_ioctl.h>    /* For the door lock/unlock commands */
  62
  63 #include "scsi_logging.h"
  64 #include "sr.h"
  65
  66
  67 MODULE_DESCRIPTION("SCSI cdrom (sr) driver");
  68 MODULE_LICENSE("GPL");
  69 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_CDROM_MAJOR);
  70 MODULE_ALIAS_SCSI_DEVICE(TYPE_ROM);
  71 MODULE_ALIAS_SCSI_DEVICE(TYPE_WORM);
  72
  73 #define SR_DISKS        256
  74
  75 #define SR_CAPABILITIES \
  76         (CDC_CLOSE_TRAY|CDC_OPEN_TRAY|CDC_LOCK|CDC_SELECT_SPEED| \
  77          CDC_SELECT_DISC|CDC_MULTI_SESSION|CDC_MCN|CDC_MEDIA_CHANGED| \
  78          CDC_PLAY_AUDIO|CDC_RESET|CDC_DRIVE_STATUS| \
  79          CDC_CD_R|CDC_CD_RW|CDC_DVD|CDC_DVD_R|CDC_DVD_RAM|CDC_GENERIC_PACKET| \
  80          CDC_MRW|CDC_MRW_W|CDC_RAM)
  81
  82 static int sr_probe(struct device *);
  83 static int sr_remove(struct device *);
  84 static blk_status_t sr_init_command(struct scsi_cmnd *SCpnt);
  85 static int sr_done(struct scsi_cmnd *);
  86 static int sr_runtime_suspend(struct device *dev);
  87
  88 static const struct dev_pm_ops sr_pm_ops = {
  89         .runtime_suspend        = sr_runtime_suspend,
  90 };
  91
  92 static struct scsi_driver sr_template = {
  93         .gendrv = {
  94                 .name           = "sr",
  95                 .owner          = THIS_MODULE,
  96                 .probe          = sr_probe,
  97                 .remove         = sr_remove,
  98                 .pm             = &sr_pm_ops,
  99         },
 100         .init_command           = sr_init_command,
 101         .done                   = sr_done,
 102 };
 103
 104 static unsigned long sr_index_bits[SR_DISKS / BITS_PER_LONG];
 105 static DEFINE_SPINLOCK(sr_index_lock);
 106
 107 /* This semaphore is used to mediate the 0->1 reference get in the
 108  * face of object destruction (i.e. we can't allow a get on an
 109  * object after last put) */
 110 static DEFINE_MUTEX(sr_ref_mutex);
 111
 112 static int sr_open(struct cdrom_device_info *, int);
 113 static void sr_release(struct cdrom_device_info *);
 114
 115 static void get_sectorsize(struct scsi_cd *);
 116 static void get_capabilities(struct scsi_cd *);
 117
 118 static unsigned int sr_check_events(struct cdrom_device_info *cdi,
 119                                     unsigned int clearing, int slot);
 120 static int sr_packet(struct cdrom_device_info *, struct packet_command *);
 121
 122 static const struct cdrom_device_ops sr_dops = {
 123         .open                   = sr_open,
 124         .release                = sr_release,
 125         .drive_status           = sr_drive_status,
 126         .check_events           = sr_check_events,
 127         .tray_move              = sr_tray_move,
 128         .lock_door              = sr_lock_door,
 129         .select_speed           = sr_select_speed,
 130         .get_last_session       = sr_get_last_session,
 131         .get_mcn                = sr_get_mcn,
 132         .reset                  = sr_reset,
 133         .audio_ioctl            = sr_audio_ioctl,
 134         .capability             = SR_CAPABILITIES,
 135         .generic_packet         = sr_packet,
 136 };
 137
 138 static void sr_kref_release(struct kref *kref);
 139
 140 static inline struct scsi_cd *scsi_cd(struct gendisk *disk)
 141 {
 142         return container_of(disk->private_data, struct scsi_cd, driver);
 143 }
 144
 145 static int sr_runtime_suspend(struct device *dev)
 146 {
 147         struct scsi_cd *cd = dev_get_drvdata(dev);
 148
 149         if (!cd)        /* E.g.: runtime suspend following sr_remove() */
 150                 return 0;
 151
 152         if (cd->media_present)
 153                 return -EBUSY;
 154         else
 155                 return 0;
 156 }
 157
 158 /*
 159  * The get and put routines for the struct scsi_cd.  Note this entity
 160  * has a scsi_device pointer and owns a reference to this.
 161  */
 162 static inline struct scsi_cd *scsi_cd_get(struct gendisk *disk)
 163 {
 164         struct scsi_cd *cd = NULL;
 165
 166         mutex_lock(&sr_ref_mutex);
 167         if (disk->private_data == NULL)
 168                 goto out;
 169         cd = scsi_cd(disk);
 170         kref_get(&cd->kref);
 171         if (scsi_device_get(cd->device)) {
 172                 kref_put(&cd->kref, sr_kref_release);
 173                 cd = NULL;
 174         }
 175  out:
 176         mutex_unlock(&sr_ref_mutex);
 177         return cd;
 178 }
 179
 180 static void scsi_cd_put(struct scsi_cd *cd)
 181 {
 182         struct scsi_device *sdev = cd->device;
 183
 184         mutex_lock(&sr_ref_mutex);
 185         kref_put(&cd->kref, sr_kref_release);
 186         scsi_device_put(sdev);
 187         mutex_unlock(&sr_ref_mutex);
 188 }
 189
 190 static unsigned int sr_get_events(struct scsi_device *sdev)
 191 {
 192         u8 buf[8];
 193         u8 cmd[] = { GET_EVENT_STATUS_NOTIFICATION,
 194                      1,                 /* polled */
 195                      0, 0,              /* reserved */
 196                      1 << 4,            /* notification class: media */
 197                      0, 0,              /* reserved */
 198                      0, sizeof(buf),    /* allocation length */
 199                      0,                 /* control */
 200         };
 201         struct event_header *eh = (void *)buf;
 202         struct media_event_desc *med = (void *)(buf + 4);
 203         struct scsi_sense_hdr sshdr;
 204         int result;
 205
 206         result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buf, sizeof(buf),
 207                                   &sshdr, SR_TIMEOUT, MAX_RETRIES, NULL);
 208         if (scsi_sense_valid(&sshdr) && sshdr.sense_key == UNIT_ATTENTION)
 209                 return DISK_EVENT_MEDIA_CHANGE;
 210
 211         if (result || be16_to_cpu(eh->data_len) < sizeof(*med))
 212                 return 0;
 213
 214         if (eh->nea || eh->notification_class != 0x4)
 215                 return 0;
 216
 217         if (med->media_event_code == 1)
 218                 return DISK_EVENT_EJECT_REQUEST;
 219         else if (med->media_event_code == 2)
 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 blk_status_t 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         blk_status_t ret;
 394
 395         ret = scsi_init_io(SCpnt);
 396         if (ret != BLK_STS_OK)
 397                 goto out;
 398         cd = scsi_cd(rq->rq_disk);
 399
 400         /* from here on until we're complete, any goto out
 401          * is used for a killable error condition */
 402         ret = BLK_STS_IOERR;
 403
 404         SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
 405                 "Doing sr request, block = %d\n", block));
 406
 407         if (!cd->device || !scsi_device_online(cd->device)) {
 408                 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
 409                         "Finishing %u sectors\n", blk_rq_sectors(rq)));
 410                 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
 411                         "Retry with 0x%p\n", SCpnt));
 412                 goto out;
 413         }
 414
 415         if (cd->device->changed) {
 416                 /*
 417                  * quietly refuse to do anything to a changed disc until the
 418                  * changed bit has been reset
 419                  */
 420                 goto out;
 421         }
 422
 423         /*
 424          * we do lazy blocksize switching (when reading XA sectors,
 425          * see CDROMREADMODE2 ioctl)
 426          */
 427         s_size = cd->device->sector_size;
 428         if (s_size > 2048) {
 429                 if (!in_interrupt())
 430                         sr_set_blocklength(cd, 2048);
 431                 else
 432                         scmd_printk(KERN_INFO, SCpnt,
 433                                     "can't switch blocksize: in interrupt\n");
 434         }
 435
 436         if (s_size != 512 && s_size != 1024 && s_size != 2048) {
 437                 scmd_printk(KERN_ERR, SCpnt, "bad sector size %d\n", s_size);
 438                 goto out;
 439         }
 440
 441         switch (req_op(rq)) {
 442         case REQ_OP_WRITE:
 443                 if (!cd->writeable)
 444                         goto out;
 445                 SCpnt->cmnd[0] = WRITE_10;
 446                 cd->cdi.media_written = 1;
 447                 break;
 448         case REQ_OP_READ:
 449                 SCpnt->cmnd[0] = READ_10;
 450                 break;
 451         default:
 452                 blk_dump_rq_flags(rq, "Unknown sr command");
 453                 goto out;
 454         }
 455
 456         {
 457                 struct scatterlist *sg;
 458                 int i, size = 0, sg_count = scsi_sg_count(SCpnt);
 459
 460                 scsi_for_each_sg(SCpnt, sg, sg_count, i)
 461                         size += sg->length;
 462
 463                 if (size != scsi_bufflen(SCpnt)) {
 464                         scmd_printk(KERN_ERR, SCpnt,
 465                                 "mismatch count %d, bytes %d\n",
 466                                 size, scsi_bufflen(SCpnt));
 467                         if (scsi_bufflen(SCpnt) > size)
 468                                 SCpnt->sdb.length = size;
 469                 }
 470         }
 471
 472         /*
 473          * request doesn't start on hw block boundary, add scatter pads
 474          */
 475         if (((unsigned int)blk_rq_pos(rq) % (s_size >> 9)) ||
 476             (scsi_bufflen(SCpnt) % s_size)) {
 477                 scmd_printk(KERN_NOTICE, SCpnt, "unaligned transfer\n");
 478                 goto out;
 479         }
 480
 481         this_count = (scsi_bufflen(SCpnt) >> 9) / (s_size >> 9);
 482
 483
 484         SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
 485                                         "%s %d/%u 512 byte blocks.\n",
 486                                         (rq_data_dir(rq) == WRITE) ?
 487                                         "writing" : "reading",
 488                                         this_count, blk_rq_sectors(rq)));
 489
 490         SCpnt->cmnd[1] = 0;
 491         block = (unsigned int)blk_rq_pos(rq) / (s_size >> 9);
 492
 493         if (this_count > 0xffff) {
 494                 this_count = 0xffff;
 495                 SCpnt->sdb.length = this_count * s_size;
 496         }
 497
 498         SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
 499         SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
 500         SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
 501         SCpnt->cmnd[5] = (unsigned char) block & 0xff;
 502         SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
 503         SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
 504         SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
 505
 506         /*
 507          * We shouldn't disconnect in the middle of a sector, so with a dumb
 508          * host adapter, it's safe to assume that we can at least transfer
 509          * this many bytes between each connect / disconnect.
 510          */
 511         SCpnt->transfersize = cd->device->sector_size;
 512         SCpnt->underflow = this_count << 9;
 513         SCpnt->allowed = MAX_RETRIES;
 514
 515         /*
 516          * This indicates that the command is ready from our end to be
 517          * queued.
 518          */
 519         ret = BLK_STS_OK;
 520  out:
 521         return ret;
 522 }
 523
 524 static int sr_block_open(struct block_device *bdev, fmode_t mode)
 525 {
 526         struct scsi_cd *cd;
 527         struct scsi_device *sdev;
 528         int ret = -ENXIO;
 529
 530         cd = scsi_cd_get(bdev->bd_disk);
 531         if (!cd)
 532                 goto out;
 533
 534         sdev = cd->device;
 535         scsi_autopm_get_device(sdev);
 536         check_disk_change(bdev);
 537
 538         mutex_lock(&cd->lock);
 539         ret = cdrom_open(&cd->cdi, bdev, mode);
 540         mutex_unlock(&cd->lock);
 541
 542         scsi_autopm_put_device(sdev);
 543         if (ret)
 544                 scsi_cd_put(cd);
 545
 546 out:
 547         return ret;
 548 }
 549
 550 static void sr_block_release(struct gendisk *disk, fmode_t mode)
 551 {
 552         struct scsi_cd *cd = scsi_cd(disk);
 553
 554         mutex_lock(&cd->lock);
 555         cdrom_release(&cd->cdi, mode);
 556         mutex_unlock(&cd->lock);
 557
 558         scsi_cd_put(cd);
 559 }
 560
 561 static int sr_block_ioctl(struct block_device *bdev, fmode_t mode, unsigned cmd,
 562                           unsigned long arg)
 563 {
 564         struct scsi_cd *cd = scsi_cd(bdev->bd_disk);
 565         struct scsi_device *sdev = cd->device;
 566         void __user *argp = (void __user *)arg;
 567         int ret;
 568
 569         mutex_lock(&cd->lock);
 570
 571         ret = scsi_ioctl_block_when_processing_errors(sdev, cmd,
 572                         (mode & FMODE_NDELAY) != 0);
 573         if (ret)
 574                 goto out;
 575
 576         scsi_autopm_get_device(sdev);
 577
 578         /*
 579          * Send SCSI addressing ioctls directly to mid level, send other
 580          * ioctls to cdrom/block level.
 581          */
 582         switch (cmd) {
 583         case SCSI_IOCTL_GET_IDLUN:
 584         case SCSI_IOCTL_GET_BUS_NUMBER:
 585                 ret = scsi_ioctl(sdev, cmd, argp);
 586                 goto put;
 587         }
 588
 589         ret = cdrom_ioctl(&cd->cdi, bdev, mode, cmd, arg);
 590         if (ret != -ENOSYS)
 591                 goto put;
 592
 593         ret = scsi_ioctl(sdev, cmd, argp);
 594
 595 put:
 596         scsi_autopm_put_device(sdev);
 597
 598 out:
 599         mutex_unlock(&cd->lock);
 600         return ret;
 601 }
 602
 603 #ifdef CONFIG_COMPAT
 604 static int sr_block_compat_ioctl(struct block_device *bdev, fmode_t mode, unsigned cmd,
 605                           unsigned long arg)
 606 {
 607         struct scsi_cd *cd = scsi_cd(bdev->bd_disk);
 608         struct scsi_device *sdev = cd->device;
 609         void __user *argp = compat_ptr(arg);
 610         int ret;
 611
 612         mutex_lock(&cd->lock);
 613
 614         ret = scsi_ioctl_block_when_processing_errors(sdev, cmd,
 615                         (mode & FMODE_NDELAY) != 0);
 616         if (ret)
 617                 goto out;
 618
 619         scsi_autopm_get_device(sdev);
 620
 621         /*
 622          * Send SCSI addressing ioctls directly to mid level, send other
 623          * ioctls to cdrom/block level.
 624          */
 625         switch (cmd) {
 626         case SCSI_IOCTL_GET_IDLUN:
 627         case SCSI_IOCTL_GET_BUS_NUMBER:
 628                 ret = scsi_compat_ioctl(sdev, cmd, argp);
 629                 goto put;
 630         }
 631
 632         ret = cdrom_ioctl(&cd->cdi, bdev, mode, cmd, (unsigned long)argp);
 633         if (ret != -ENOSYS)
 634                 goto put;
 635
 636         ret = scsi_compat_ioctl(sdev, cmd, argp);
 637
 638 put:
 639         scsi_autopm_put_device(sdev);
 640
 641 out:
 642         mutex_unlock(&cd->lock);
 643         return ret;
 644
 645 }
 646 #endif
 647
 648 static unsigned int sr_block_check_events(struct gendisk *disk,
 649                                           unsigned int clearing)
 650 {
 651         unsigned int ret = 0;
 652         struct scsi_cd *cd;
 653
 654         cd = scsi_cd_get(disk);
 655         if (!cd)
 656                 return 0;
 657
 658         if (!atomic_read(&cd->device->disk_events_disable_depth))
 659                 ret = cdrom_check_events(&cd->cdi, clearing);
 660
 661         scsi_cd_put(cd);
 662         return ret;
 663 }
 664
 665 static int sr_block_revalidate_disk(struct gendisk *disk)
 666 {
 667         struct scsi_sense_hdr sshdr;
 668         struct scsi_cd *cd;
 669
 670         cd = scsi_cd_get(disk);
 671         if (!cd)
 672                 return -ENXIO;
 673
 674         /* if the unit is not ready, nothing more to do */
 675         if (scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr))
 676                 goto out;
 677
 678         sr_cd_check(&cd->cdi);
 679         get_sectorsize(cd);
 680 out:
 681         scsi_cd_put(cd);
 682         return 0;
 683 }
 684
 685 static const struct block_device_operations sr_bdops =
 686 {
 687         .owner          = THIS_MODULE,
 688         .open           = sr_block_open,
 689         .release        = sr_block_release,
 690         .ioctl          = sr_block_ioctl,
 691 #ifdef CONFIG_COMPAT
 692         .compat_ioctl   = sr_block_compat_ioctl,
 693 #endif
 694         .check_events   = sr_block_check_events,
 695         .revalidate_disk = sr_block_revalidate_disk,
 696 };
 697
 698 static int sr_open(struct cdrom_device_info *cdi, int purpose)
 699 {
 700         struct scsi_cd *cd = cdi->handle;
 701         struct scsi_device *sdev = cd->device;
 702         int retval;
 703
 704         /*
 705          * If the device is in error recovery, wait until it is done.
 706          * If the device is offline, then disallow any access to it.
 707          */
 708         retval = -ENXIO;
 709         if (!scsi_block_when_processing_errors(sdev))
 710                 goto error_out;
 711
 712         return 0;
 713
 714 error_out:
 715         return retval;
 716 }
 717
 718 static void sr_release(struct cdrom_device_info *cdi)
 719 {
 720         struct scsi_cd *cd = cdi->handle;
 721
 722         if (cd->device->sector_size > 2048)
 723                 sr_set_blocklength(cd, 2048);
 724
 725 }
 726
 727 static int sr_probe(struct device *dev)
 728 {
 729         struct scsi_device *sdev = to_scsi_device(dev);
 730         struct gendisk *disk;
 731         struct scsi_cd *cd;
 732         int minor, error;
 733
 734         scsi_autopm_get_device(sdev);
 735         error = -ENODEV;
 736         if (sdev->type != TYPE_ROM && sdev->type != TYPE_WORM)
 737                 goto fail;
 738
 739         error = -ENOMEM;
 740         cd = kzalloc(sizeof(*cd), GFP_KERNEL);
 741         if (!cd)
 742                 goto fail;
 743
 744         kref_init(&cd->kref);
 745
 746         disk = alloc_disk(1);
 747         if (!disk)
 748                 goto fail_free;
 749         mutex_init(&cd->lock);
 750
 751         spin_lock(&sr_index_lock);
 752         minor = find_first_zero_bit(sr_index_bits, SR_DISKS);
 753         if (minor == SR_DISKS) {
 754                 spin_unlock(&sr_index_lock);
 755                 error = -EBUSY;
 756                 goto fail_put;
 757         }
 758         __set_bit(minor, sr_index_bits);
 759         spin_unlock(&sr_index_lock);
 760
 761         disk->major = SCSI_CDROM_MAJOR;
 762         disk->first_minor = minor;
 763         sprintf(disk->disk_name, "sr%d", minor);
 764         disk->fops = &sr_bdops;
 765         disk->flags = GENHD_FL_CD | GENHD_FL_BLOCK_EVENTS_ON_EXCL_WRITE;
 766         disk->events = DISK_EVENT_MEDIA_CHANGE | DISK_EVENT_EJECT_REQUEST;
 767         disk->event_flags = DISK_EVENT_FLAG_POLL | DISK_EVENT_FLAG_UEVENT;
 768
 769         blk_queue_rq_timeout(sdev->request_queue, SR_TIMEOUT);
 770
 771         cd->device = sdev;
 772         cd->disk = disk;
 773         cd->driver = &sr_template;
 774         cd->disk = disk;
 775         cd->capacity = 0x1fffff;
 776         cd->device->changed = 1;        /* force recheck CD type */
 777         cd->media_present = 1;
 778         cd->use = 1;
 779         cd->readcd_known = 0;
 780         cd->readcd_cdda = 0;
 781
 782         cd->cdi.ops = &sr_dops;
 783         cd->cdi.handle = cd;
 784         cd->cdi.mask = 0;
 785         cd->cdi.capacity = 1;
 786         sprintf(cd->cdi.name, "sr%d", minor);
 787
 788         sdev->sector_size = 2048;       /* A guess, just in case */
 789
 790         /* FIXME: need to handle a get_capabilities failure properly ?? */
 791         get_capabilities(cd);
 792         sr_vendor_init(cd);
 793
 794         set_capacity(disk, cd->capacity);
 795         disk->private_data = &cd->driver;
 796         disk->queue = sdev->request_queue;
 797         cd->cdi.disk = disk;
 798
 799         if (register_cdrom(&cd->cdi))
 800                 goto fail_put;
 801
 802         /*
 803          * Initialize block layer runtime PM stuffs before the
 804          * periodic event checking request gets started in add_disk.
 805          */
 806         blk_pm_runtime_init(sdev->request_queue, dev);
 807
 808         dev_set_drvdata(dev, cd);
 809         disk->flags |= GENHD_FL_REMOVABLE;
 810         device_add_disk(&sdev->sdev_gendev, disk, NULL);
 811
 812         sdev_printk(KERN_DEBUG, sdev,
 813                     "Attached scsi CD-ROM %s\n", cd->cdi.name);
 814         scsi_autopm_put_device(cd->device);
 815
 816         return 0;
 817
 818 fail_put:
 819         put_disk(disk);
 820 fail_free:
 821         kfree(cd);
 822 fail:
 823         scsi_autopm_put_device(sdev);
 824         return error;
 825 }
 826
 827
 828 static void get_sectorsize(struct scsi_cd *cd)
 829 {
 830         unsigned char cmd[10];
 831         unsigned char buffer[8];
 832         int the_result, retries = 3;
 833         int sector_size;
 834         struct request_queue *queue;
 835
 836         do {
 837                 cmd[0] = READ_CAPACITY;
 838                 memset((void *) &cmd[1], 0, 9);
 839                 memset(buffer, 0, sizeof(buffer));
 840
 841                 /* Do the command and wait.. */
 842                 the_result = scsi_execute_req(cd->device, cmd, DMA_FROM_DEVICE,
 843                                               buffer, sizeof(buffer), NULL,
 844                                               SR_TIMEOUT, MAX_RETRIES, NULL);
 845
 846                 retries--;
 847
 848         } while (the_result && retries);
 849
 850
 851         if (the_result) {
 852                 cd->capacity = 0x1fffff;
 853                 sector_size = 2048;     /* A guess, just in case */
 854         } else {
 855                 long last_written;
 856
 857                 cd->capacity = 1 + ((buffer[0] << 24) | (buffer[1] << 16) |
 858                                     (buffer[2] << 8) | buffer[3]);
 859                 /*
 860                  * READ_CAPACITY doesn't return the correct size on
 861                  * certain UDF media.  If last_written is larger, use
 862                  * it instead.
 863                  *
 864                  * http://bugzilla.kernel.org/show_bug.cgi?id=9668
 865                  */
 866                 if (!cdrom_get_last_written(&cd->cdi, &last_written))
 867                         cd->capacity = max_t(long, cd->capacity, last_written);
 868
 869                 sector_size = (buffer[4] << 24) |
 870                     (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
 871                 switch (sector_size) {
 872                         /*
 873                          * HP 4020i CD-Recorder reports 2340 byte sectors
 874                          * Philips CD-Writers report 2352 byte sectors
 875                          *
 876                          * Use 2k sectors for them..
 877                          */
 878                 case 0:
 879                 case 2340:
 880                 case 2352:
 881                         sector_size = 2048;
 882                         /* fall through */
 883                 case 2048:
 884                         cd->capacity *= 4;
 885                         /* fall through */
 886                 case 512:
 887                         break;
 888                 default:
 889                         sr_printk(KERN_INFO, cd,
 890                                   "unsupported sector size %d.", sector_size);
 891                         cd->capacity = 0;
 892                 }
 893
 894                 cd->device->sector_size = sector_size;
 895
 896                 /*
 897                  * Add this so that we have the ability to correctly gauge
 898                  * what the device is capable of.
 899                  */
 900                 set_capacity(cd->disk, cd->capacity);
 901         }
 902
 903         queue = cd->device->request_queue;
 904         blk_queue_logical_block_size(queue, sector_size);
 905
 906         return;
 907 }
 908
 909 static void get_capabilities(struct scsi_cd *cd)
 910 {
 911         unsigned char *buffer;
 912         struct scsi_mode_data data;
 913         struct scsi_sense_hdr sshdr;
 914         unsigned int ms_len = 128;
 915         int rc, n;
 916
 917         static const char *loadmech[] =
 918         {
 919                 "caddy",
 920                 "tray",
 921                 "pop-up",
 922                 "",
 923                 "changer",
 924                 "cartridge changer",
 925                 "",
 926                 ""
 927         };
 928
 929
 930         /* allocate transfer buffer */
 931         buffer = kmalloc(512, GFP_KERNEL | GFP_DMA);
 932         if (!buffer) {
 933                 sr_printk(KERN_ERR, cd, "out of memory.\n");
 934                 return;
 935         }
 936
 937         /* eat unit attentions */
 938         scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr);
 939
 940         /* ask for mode page 0x2a */
 941         rc = scsi_mode_sense(cd->device, 0, 0x2a, buffer, ms_len,
 942                              SR_TIMEOUT, 3, &data, NULL);
 943
 944         if (!scsi_status_is_good(rc) || data.length > ms_len ||
 945             data.header_length + data.block_descriptor_length > data.length) {
 946                 /* failed, drive doesn't have capabilities mode page */
 947                 cd->cdi.speed = 1;
 948                 cd->cdi.mask |= (CDC_CD_R | CDC_CD_RW | CDC_DVD_R |
 949                                  CDC_DVD | CDC_DVD_RAM |
 950                                  CDC_SELECT_DISC | CDC_SELECT_SPEED |
 951                                  CDC_MRW | CDC_MRW_W | CDC_RAM);
 952                 kfree(buffer);
 953                 sr_printk(KERN_INFO, cd, "scsi-1 drive");
 954                 return;
 955         }
 956
 957         n = data.header_length + data.block_descriptor_length;
 958         cd->cdi.speed = ((buffer[n + 8] << 8) + buffer[n + 9]) / 176;
 959         cd->readcd_known = 1;
 960         cd->readcd_cdda = buffer[n + 5] & 0x01;
 961         /* print some capability bits */
 962         sr_printk(KERN_INFO, cd,
 963                   "scsi3-mmc drive: %dx/%dx %s%s%s%s%s%s\n",
 964                   ((buffer[n + 14] << 8) + buffer[n + 15]) / 176,
 965                   cd->cdi.speed,
 966                   buffer[n + 3] & 0x01 ? "writer " : "", /* CD Writer */
 967                   buffer[n + 3] & 0x20 ? "dvd-ram " : "",
 968                   buffer[n + 2] & 0x02 ? "cd/rw " : "", /* can read rewriteable */
 969                   buffer[n + 4] & 0x20 ? "xa/form2 " : "",      /* can read xa/from2 */
 970                   buffer[n + 5] & 0x01 ? "cdda " : "", /* can read audio data */
 971                   loadmech[buffer[n + 6] >> 5]);
 972         if ((buffer[n + 6] >> 5) == 0)
 973                 /* caddy drives can't close tray... */
 974                 cd->cdi.mask |= CDC_CLOSE_TRAY;
 975         if ((buffer[n + 2] & 0x8) == 0)
 976                 /* not a DVD drive */
 977                 cd->cdi.mask |= CDC_DVD;
 978         if ((buffer[n + 3] & 0x20) == 0)
 979                 /* can't write DVD-RAM media */
 980                 cd->cdi.mask |= CDC_DVD_RAM;
 981         if ((buffer[n + 3] & 0x10) == 0)
 982                 /* can't write DVD-R media */
 983                 cd->cdi.mask |= CDC_DVD_R;
 984         if ((buffer[n + 3] & 0x2) == 0)
 985                 /* can't write CD-RW media */
 986                 cd->cdi.mask |= CDC_CD_RW;
 987         if ((buffer[n + 3] & 0x1) == 0)
 988                 /* can't write CD-R media */
 989                 cd->cdi.mask |= CDC_CD_R;
 990         if ((buffer[n + 6] & 0x8) == 0)
 991                 /* can't eject */
 992                 cd->cdi.mask |= CDC_OPEN_TRAY;
 993
 994         if ((buffer[n + 6] >> 5) == mechtype_individual_changer ||
 995             (buffer[n + 6] >> 5) == mechtype_cartridge_changer)
 996                 cd->cdi.capacity =
 997                     cdrom_number_of_slots(&cd->cdi);
 998         if (cd->cdi.capacity <= 1)
 999                 /* not a changer */
1000                 cd->cdi.mask |= CDC_SELECT_DISC;
1001         /*else    I don't think it can close its tray
1002                 cd->cdi.mask |= CDC_CLOSE_TRAY; */
1003
1004         /*
1005          * if DVD-RAM, MRW-W or CD-RW, we are randomly writable
1006          */
1007         if ((cd->cdi.mask & (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) !=
1008                         (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) {
1009                 cd->writeable = 1;
1010         }
1011
1012         kfree(buffer);
1013 }
1014
1015 /*
1016  * sr_packet() is the entry point for the generic commands generated
1017  * by the Uniform CD-ROM layer.
1018  */
1019 static int sr_packet(struct cdrom_device_info *cdi,
1020                 struct packet_command *cgc)
1021 {
1022         struct scsi_cd *cd = cdi->handle;
1023         struct scsi_device *sdev = cd->device;
1024
1025         if (cgc->cmd[0] == GPCMD_READ_DISC_INFO && sdev->no_read_disc_info)
1026                 return -EDRIVE_CANT_DO_THIS;
1027
1028         if (cgc->timeout <= 0)
1029                 cgc->timeout = IOCTL_TIMEOUT;
1030
1031         sr_do_ioctl(cd, cgc);
1032
1033         return cgc->stat;
1034 }
1035
1036 /**
1037  *      sr_kref_release - Called to free the scsi_cd structure
1038  *      @kref: pointer to embedded kref
1039  *
1040  *      sr_ref_mutex must be held entering this routine.  Because it is
1041  *      called on last put, you should always use the scsi_cd_get()
1042  *      scsi_cd_put() helpers which manipulate the semaphore directly
1043  *      and never do a direct kref_put().
1044  **/
1045 static void sr_kref_release(struct kref *kref)
1046 {
1047         struct scsi_cd *cd = container_of(kref, struct scsi_cd, kref);
1048         struct gendisk *disk = cd->disk;
1049
1050         spin_lock(&sr_index_lock);
1051         clear_bit(MINOR(disk_devt(disk)), sr_index_bits);
1052         spin_unlock(&sr_index_lock);
1053
1054         unregister_cdrom(&cd->cdi);
1055
1056         disk->private_data = NULL;
1057
1058         put_disk(disk);
1059
1060         mutex_destroy(&cd->lock);
1061
1062         kfree(cd);
1063 }
1064
1065 static int sr_remove(struct device *dev)
1066 {
1067         struct scsi_cd *cd = dev_get_drvdata(dev);
1068
1069         scsi_autopm_get_device(cd->device);
1070
1071         del_gendisk(cd->disk);
1072         dev_set_drvdata(dev, NULL);
1073
1074         mutex_lock(&sr_ref_mutex);
1075         kref_put(&cd->kref, sr_kref_release);
1076         mutex_unlock(&sr_ref_mutex);
1077
1078         return 0;
1079 }
1080
1081 static int __init init_sr(void)
1082 {
1083         int rc;
1084
1085         rc = register_blkdev(SCSI_CDROM_MAJOR, "sr");
1086         if (rc)
1087                 return rc;
1088         rc = scsi_register_driver(&sr_template.gendrv);
1089         if (rc)
1090                 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
1091
1092         return rc;
1093 }
1094
1095 static void __exit exit_sr(void)
1096 {
1097         scsi_unregister_driver(&sr_template.gendrv);
1098         unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
1099 }
1100
1101 module_init(init_sr);
1102 module_exit(exit_sr);
1103 MODULE_LICENSE("GPL");