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