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