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 <[email protected]>
  10  *
  11  *      Modified by Eric Youngdale [email protected] to
  12  *      add scatter-gather, multiple outstanding request, and other
  13  *      enhancements.
  14  *
  15  *      Modified by Eric Youngdale [email protected] to support loadable
  16  *      low-level scsi drivers.
  17  *
  18  *      Modified by Thomas Quinot [email protected] to
  19  *      provide auto-eject.
  20  *
  21  *      Modified by Gerd Knorr <[email protected]> to support the
  22  *      generic cdrom interface
  23  *
  24  *      Modified by Jens Axboe <[email protected]> - Uniform sr_packet()
  25  *      interface, capabilities probe additions, ioctl cleanups, etc.
  26  *
  27  *      Modified by Richard Gooch <[email protected]> to support devfs
  28  *
  29  *      Modified by Jens Axboe <[email protected]> - support DVD-RAM
  30  *      transparently and lose the GHOST hack
  31  *
  32  *      Modified by Arnaldo Carvalho de Melo <[email protected]>
  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 <linux/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                 .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 static struct lock_class_key sr_bio_compl_lkclass;
 110
 111 static int sr_open(struct cdrom_device_info *, int);
 112 static void sr_release(struct cdrom_device_info *);
 113
 114 static int get_sectorsize(struct scsi_cd *);
 115 static int get_capabilities(struct scsi_cd *);
 116
 117 static unsigned int sr_check_events(struct cdrom_device_info *cdi,
 118                                     unsigned int clearing, int slot);
 119 static int sr_packet(struct cdrom_device_info *, struct packet_command *);
 120 static int sr_read_cdda_bpc(struct cdrom_device_info *cdi, void __user *ubuf,
 121                 u32 lba, u32 nr, u8 *last_sense);
 122
 123 static const struct cdrom_device_ops sr_dops = {
 124         .open                   = sr_open,
 125         .release                = sr_release,
 126         .drive_status           = sr_drive_status,
 127         .check_events           = sr_check_events,
 128         .tray_move              = sr_tray_move,
 129         .lock_door              = sr_lock_door,
 130         .select_speed           = sr_select_speed,
 131         .get_last_session       = sr_get_last_session,
 132         .get_mcn                = sr_get_mcn,
 133         .reset                  = sr_reset,
 134         .audio_ioctl            = sr_audio_ioctl,
 135         .generic_packet         = sr_packet,
 136         .read_cdda_bpc          = sr_read_cdda_bpc,
 137         .capability             = SR_CAPABILITIES,
 138 };
 139
 140 static inline struct scsi_cd *scsi_cd(struct gendisk *disk)
 141 {
 142         return disk->private_data;
 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 static unsigned int sr_get_events(struct scsi_device *sdev)
 159 {
 160         u8 buf[8];
 161         u8 cmd[] = { GET_EVENT_STATUS_NOTIFICATION,
 162                      1,                 /* polled */
 163                      0, 0,              /* reserved */
 164                      1 << 4,            /* notification class: media */
 165                      0, 0,              /* reserved */
 166                      0, sizeof(buf),    /* allocation length */
 167                      0,                 /* control */
 168         };
 169         struct event_header *eh = (void *)buf;
 170         struct media_event_desc *med = (void *)(buf + 4);
 171         struct scsi_sense_hdr sshdr;
 172         const struct scsi_exec_args exec_args = {
 173                 .sshdr = &sshdr,
 174         };
 175         int result;
 176
 177         result = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_IN, buf, sizeof(buf),
 178                                   SR_TIMEOUT, MAX_RETRIES, &exec_args);
 179         if (result > 0 && scsi_sense_valid(&sshdr) &&
 180             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 int 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 0;
 483         sr_cd_check(&cd->cdi);
 484         return 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                 ret = sr_revalidate_disk(cd);
 499                 if (ret)
 500                         goto out;
 501         }
 502
 503         mutex_lock(&cd->lock);
 504         ret = cdrom_open(&cd->cdi, mode);
 505         mutex_unlock(&cd->lock);
 506 out:
 507         scsi_autopm_put_device(sdev);
 508         if (ret)
 509                 scsi_device_put(cd->device);
 510         return ret;
 511 }
 512
 513 static void sr_block_release(struct gendisk *disk)
 514 {
 515         struct scsi_cd *cd = scsi_cd(disk);
 516
 517         mutex_lock(&cd->lock);
 518         cdrom_release(&cd->cdi);
 519         mutex_unlock(&cd->lock);
 520
 521         scsi_device_put(cd->device);
 522 }
 523
 524 static int sr_block_ioctl(struct block_device *bdev, blk_mode_t mode,
 525                 unsigned cmd, unsigned long arg)
 526 {
 527         struct scsi_cd *cd = scsi_cd(bdev->bd_disk);
 528         struct scsi_device *sdev = cd->device;
 529         void __user *argp = (void __user *)arg;
 530         int ret;
 531
 532         if (bdev_is_partition(bdev) && !capable(CAP_SYS_RAWIO))
 533                 return -ENOIOCTLCMD;
 534
 535         mutex_lock(&cd->lock);
 536
 537         ret = scsi_ioctl_block_when_processing_errors(sdev, cmd,
 538                         (mode & BLK_OPEN_NDELAY));
 539         if (ret)
 540                 goto out;
 541
 542         scsi_autopm_get_device(sdev);
 543
 544         if (cmd != CDROMCLOSETRAY && cmd != CDROMEJECT) {
 545                 ret = cdrom_ioctl(&cd->cdi, bdev, cmd, arg);
 546                 if (ret != -ENOSYS)
 547                         goto put;
 548         }
 549         ret = scsi_ioctl(sdev, mode & BLK_OPEN_WRITE, cmd, argp);
 550
 551 put:
 552         scsi_autopm_put_device(sdev);
 553 out:
 554         mutex_unlock(&cd->lock);
 555         return ret;
 556 }
 557
 558 static unsigned int sr_block_check_events(struct gendisk *disk,
 559                                           unsigned int clearing)
 560 {
 561         struct scsi_cd *cd = disk->private_data;
 562
 563         if (atomic_read(&cd->device->disk_events_disable_depth))
 564                 return 0;
 565         return cdrom_check_events(&cd->cdi, clearing);
 566 }
 567
 568 static void sr_free_disk(struct gendisk *disk)
 569 {
 570         struct scsi_cd *cd = disk->private_data;
 571
 572         spin_lock(&sr_index_lock);
 573         clear_bit(MINOR(disk_devt(disk)), sr_index_bits);
 574         spin_unlock(&sr_index_lock);
 575
 576         unregister_cdrom(&cd->cdi);
 577         mutex_destroy(&cd->lock);
 578         kfree(cd);
 579 }
 580
 581 static const struct block_device_operations sr_bdops =
 582 {
 583         .owner          = THIS_MODULE,
 584         .open           = sr_block_open,
 585         .release        = sr_block_release,
 586         .ioctl          = sr_block_ioctl,
 587         .compat_ioctl   = blkdev_compat_ptr_ioctl,
 588         .check_events   = sr_block_check_events,
 589         .free_disk      = sr_free_disk,
 590 };
 591
 592 static int sr_open(struct cdrom_device_info *cdi, int purpose)
 593 {
 594         struct scsi_cd *cd = cdi->handle;
 595         struct scsi_device *sdev = cd->device;
 596
 597         /*
 598          * If the device is in error recovery, wait until it is done.
 599          * If the device is offline, then disallow any access to it.
 600          */
 601         if (!scsi_block_when_processing_errors(sdev))
 602                 return -ENXIO;
 603
 604         return 0;
 605 }
 606
 607 static void sr_release(struct cdrom_device_info *cdi)
 608 {
 609 }
 610
 611 static int sr_probe(struct device *dev)
 612 {
 613         struct scsi_device *sdev = to_scsi_device(dev);
 614         struct gendisk *disk;
 615         struct scsi_cd *cd;
 616         int minor, error;
 617
 618         scsi_autopm_get_device(sdev);
 619         error = -ENODEV;
 620         if (sdev->type != TYPE_ROM && sdev->type != TYPE_WORM)
 621                 goto fail;
 622
 623         error = -ENOMEM;
 624         cd = kzalloc(sizeof(*cd), GFP_KERNEL);
 625         if (!cd)
 626                 goto fail;
 627
 628         disk = blk_mq_alloc_disk_for_queue(sdev->request_queue,
 629                                            &sr_bio_compl_lkclass);
 630         if (!disk)
 631                 goto fail_free;
 632         mutex_init(&cd->lock);
 633
 634         spin_lock(&sr_index_lock);
 635         minor = find_first_zero_bit(sr_index_bits, SR_DISKS);
 636         if (minor == SR_DISKS) {
 637                 spin_unlock(&sr_index_lock);
 638                 error = -EBUSY;
 639                 goto fail_put;
 640         }
 641         __set_bit(minor, sr_index_bits);
 642         spin_unlock(&sr_index_lock);
 643
 644         disk->major = SCSI_CDROM_MAJOR;
 645         disk->first_minor = minor;
 646         disk->minors = 1;
 647         sprintf(disk->disk_name, "sr%d", minor);
 648         disk->fops = &sr_bdops;
 649         disk->flags |= GENHD_FL_REMOVABLE | GENHD_FL_NO_PART;
 650         disk->events = DISK_EVENT_MEDIA_CHANGE | DISK_EVENT_EJECT_REQUEST;
 651         disk->event_flags = DISK_EVENT_FLAG_POLL | DISK_EVENT_FLAG_UEVENT |
 652                                 DISK_EVENT_FLAG_BLOCK_ON_EXCL_WRITE;
 653
 654         blk_queue_rq_timeout(sdev->request_queue, SR_TIMEOUT);
 655
 656         cd->device = sdev;
 657         cd->disk = disk;
 658         cd->capacity = 0x1fffff;
 659         cd->device->changed = 1;        /* force recheck CD type */
 660         cd->media_present = 1;
 661         cd->use = 1;
 662         cd->readcd_known = 0;
 663         cd->readcd_cdda = 0;
 664
 665         cd->cdi.ops = &sr_dops;
 666         cd->cdi.handle = cd;
 667         cd->cdi.mask = 0;
 668         cd->cdi.capacity = 1;
 669         sprintf(cd->cdi.name, "sr%d", minor);
 670
 671         sdev->sector_size = 2048;       /* A guess, just in case */
 672
 673         error = -ENOMEM;
 674         if (get_capabilities(cd))
 675                 goto fail_minor;
 676         sr_vendor_init(cd);
 677
 678         set_capacity(disk, cd->capacity);
 679         disk->private_data = cd;
 680
 681         if (register_cdrom(disk, &cd->cdi))
 682                 goto fail_minor;
 683
 684         /*
 685          * Initialize block layer runtime PM stuffs before the
 686          * periodic event checking request gets started in add_disk.
 687          */
 688         blk_pm_runtime_init(sdev->request_queue, dev);
 689
 690         dev_set_drvdata(dev, cd);
 691         error = sr_revalidate_disk(cd);
 692         if (error)
 693                 goto unregister_cdrom;
 694
 695         error = device_add_disk(&sdev->sdev_gendev, disk, NULL);
 696         if (error)
 697                 goto unregister_cdrom;
 698
 699         sdev_printk(KERN_DEBUG, sdev,
 700                     "Attached scsi CD-ROM %s\n", cd->cdi.name);
 701         scsi_autopm_put_device(cd->device);
 702
 703         return 0;
 704
 705 unregister_cdrom:
 706         unregister_cdrom(&cd->cdi);
 707 fail_minor:
 708         spin_lock(&sr_index_lock);
 709         clear_bit(minor, sr_index_bits);
 710         spin_unlock(&sr_index_lock);
 711 fail_put:
 712         put_disk(disk);
 713         mutex_destroy(&cd->lock);
 714 fail_free:
 715         kfree(cd);
 716 fail:
 717         scsi_autopm_put_device(sdev);
 718         return error;
 719 }
 720
 721
 722 static int get_sectorsize(struct scsi_cd *cd)
 723 {
 724         struct request_queue *q = cd->device->request_queue;
 725         static const u8 cmd[10] = { READ_CAPACITY };
 726         unsigned char buffer[8] = { };
 727         struct queue_limits lim;
 728         int err;
 729         int sector_size;
 730         struct scsi_failure failure_defs[] = {
 731                 {
 732                         .result = SCMD_FAILURE_RESULT_ANY,
 733                         .allowed = 3,
 734                 },
 735                 {}
 736         };
 737         struct scsi_failures failures = {
 738                 .failure_definitions = failure_defs,
 739         };
 740         const struct scsi_exec_args exec_args = {
 741                 .failures = &failures,
 742         };
 743
 744         /* Do the command and wait.. */
 745         err = scsi_execute_cmd(cd->device, cmd, REQ_OP_DRV_IN, buffer,
 746                                       sizeof(buffer), SR_TIMEOUT, MAX_RETRIES,
 747                                       &exec_args);
 748         if (err) {
 749                 cd->capacity = 0x1fffff;
 750                 sector_size = 2048;     /* A guess, just in case */
 751         } else {
 752                 long last_written;
 753
 754                 cd->capacity = 1 + get_unaligned_be32(&buffer[0]);
 755                 /*
 756                  * READ_CAPACITY doesn't return the correct size on
 757                  * certain UDF media.  If last_written is larger, use
 758                  * it instead.
 759                  *
 760                  * http://bugzilla.kernel.org/show_bug.cgi?id=9668
 761                  */
 762                 if (!cdrom_get_last_written(&cd->cdi, &last_written))
 763                         cd->capacity = max_t(long, cd->capacity, last_written);
 764
 765                 sector_size = get_unaligned_be32(&buffer[4]);
 766                 switch (sector_size) {
 767                         /*
 768                          * HP 4020i CD-Recorder reports 2340 byte sectors
 769                          * Philips CD-Writers report 2352 byte sectors
 770                          *
 771                          * Use 2k sectors for them..
 772                          */
 773                 case 0:
 774                 case 2340:
 775                 case 2352:
 776                         sector_size = 2048;
 777                         fallthrough;
 778                 case 2048:
 779                         cd->capacity *= 4;
 780                         fallthrough;
 781                 case 512:
 782                         break;
 783                 default:
 784                         sr_printk(KERN_INFO, cd,
 785                                   "unsupported sector size %d.", sector_size);
 786                         cd->capacity = 0;
 787                 }
 788
 789                 cd->device->sector_size = sector_size;
 790
 791                 /*
 792                  * Add this so that we have the ability to correctly gauge
 793                  * what the device is capable of.
 794                  */
 795                 set_capacity(cd->disk, cd->capacity);
 796         }
 797
 798         lim = queue_limits_start_update(q);
 799         lim.logical_block_size = sector_size;
 800         blk_mq_freeze_queue(q);
 801         err = queue_limits_commit_update(q, &lim);
 802         blk_mq_unfreeze_queue(q);
 803         return err;
 804 }
 805
 806 static int get_capabilities(struct scsi_cd *cd)
 807 {
 808         unsigned char *buffer;
 809         struct scsi_mode_data data;
 810         struct scsi_sense_hdr sshdr;
 811         unsigned int ms_len = 128;
 812         int rc, n;
 813
 814         static const char *loadmech[] =
 815         {
 816                 "caddy",
 817                 "tray",
 818                 "pop-up",
 819                 "",
 820                 "changer",
 821                 "cartridge changer",
 822                 "",
 823                 ""
 824         };
 825
 826
 827         /* allocate transfer buffer */
 828         buffer = kmalloc(512, GFP_KERNEL);
 829         if (!buffer) {
 830                 sr_printk(KERN_ERR, cd, "out of memory.\n");
 831                 return -ENOMEM;
 832         }
 833
 834         /* eat unit attentions */
 835         scsi_test_unit_ready(cd->device, SR_TIMEOUT, MAX_RETRIES, &sshdr);
 836
 837         /* ask for mode page 0x2a */
 838         rc = scsi_mode_sense(cd->device, 0, 0x2a, 0, buffer, ms_len,
 839                              SR_TIMEOUT, 3, &data, NULL);
 840
 841         if (rc < 0 || data.length > ms_len ||
 842             data.header_length + data.block_descriptor_length > data.length) {
 843                 /* failed, drive doesn't have capabilities mode page */
 844                 cd->cdi.speed = 1;
 845                 cd->cdi.mask |= (CDC_CD_R | CDC_CD_RW | CDC_DVD_R |
 846                                  CDC_DVD | CDC_DVD_RAM |
 847                                  CDC_SELECT_DISC | CDC_SELECT_SPEED |
 848                                  CDC_MRW | CDC_MRW_W | CDC_RAM);
 849                 kfree(buffer);
 850                 sr_printk(KERN_INFO, cd, "scsi-1 drive");
 851                 return 0;
 852         }
 853
 854         n = data.header_length + data.block_descriptor_length;
 855         cd->cdi.speed = get_unaligned_be16(&buffer[n + 8]) / 176;
 856         cd->readcd_known = 1;
 857         cd->readcd_cdda = buffer[n + 5] & 0x01;
 858         /* print some capability bits */
 859         sr_printk(KERN_INFO, cd,
 860                   "scsi3-mmc drive: %dx/%dx %s%s%s%s%s%s\n",
 861                   get_unaligned_be16(&buffer[n + 14]) / 176,
 862                   cd->cdi.speed,
 863                   buffer[n + 3] & 0x01 ? "writer " : "", /* CD Writer */
 864                   buffer[n + 3] & 0x20 ? "dvd-ram " : "",
 865                   buffer[n + 2] & 0x02 ? "cd/rw " : "", /* can read rewriteable */
 866                   buffer[n + 4] & 0x20 ? "xa/form2 " : "",      /* can read xa/from2 */
 867                   buffer[n + 5] & 0x01 ? "cdda " : "", /* can read audio data */
 868                   loadmech[buffer[n + 6] >> 5]);
 869         if ((buffer[n + 6] >> 5) == 0)
 870                 /* caddy drives can't close tray... */
 871                 cd->cdi.mask |= CDC_CLOSE_TRAY;
 872         if ((buffer[n + 2] & 0x8) == 0)
 873                 /* not a DVD drive */
 874                 cd->cdi.mask |= CDC_DVD;
 875         if ((buffer[n + 3] & 0x20) == 0)
 876                 /* can't write DVD-RAM media */
 877                 cd->cdi.mask |= CDC_DVD_RAM;
 878         if ((buffer[n + 3] & 0x10) == 0)
 879                 /* can't write DVD-R media */
 880                 cd->cdi.mask |= CDC_DVD_R;
 881         if ((buffer[n + 3] & 0x2) == 0)
 882                 /* can't write CD-RW media */
 883                 cd->cdi.mask |= CDC_CD_RW;
 884         if ((buffer[n + 3] & 0x1) == 0)
 885                 /* can't write CD-R media */
 886                 cd->cdi.mask |= CDC_CD_R;
 887         if ((buffer[n + 6] & 0x8) == 0)
 888                 /* can't eject */
 889                 cd->cdi.mask |= CDC_OPEN_TRAY;
 890
 891         if ((buffer[n + 6] >> 5) == mechtype_individual_changer ||
 892             (buffer[n + 6] >> 5) == mechtype_cartridge_changer)
 893                 cd->cdi.capacity =
 894                     cdrom_number_of_slots(&cd->cdi);
 895         if (cd->cdi.capacity <= 1)
 896                 /* not a changer */
 897                 cd->cdi.mask |= CDC_SELECT_DISC;
 898         /*else    I don't think it can close its tray
 899                 cd->cdi.mask |= CDC_CLOSE_TRAY; */
 900
 901         /*
 902          * if DVD-RAM, MRW-W or CD-RW, we are randomly writable
 903          */
 904         if ((cd->cdi.mask & (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) !=
 905                         (CDC_DVD_RAM | CDC_MRW_W | CDC_RAM | CDC_CD_RW)) {
 906                 cd->writeable = 1;
 907         }
 908
 909         kfree(buffer);
 910         return 0;
 911 }
 912
 913 /*
 914  * sr_packet() is the entry point for the generic commands generated
 915  * by the Uniform CD-ROM layer.
 916  */
 917 static int sr_packet(struct cdrom_device_info *cdi,
 918                 struct packet_command *cgc)
 919 {
 920         struct scsi_cd *cd = cdi->handle;
 921         struct scsi_device *sdev = cd->device;
 922
 923         if (cgc->cmd[0] == GPCMD_READ_DISC_INFO && sdev->no_read_disc_info)
 924                 return -EDRIVE_CANT_DO_THIS;
 925
 926         if (cgc->timeout <= 0)
 927                 cgc->timeout = IOCTL_TIMEOUT;
 928
 929         sr_do_ioctl(cd, cgc);
 930
 931         return cgc->stat;
 932 }
 933
 934 static int sr_read_cdda_bpc(struct cdrom_device_info *cdi, void __user *ubuf,
 935                 u32 lba, u32 nr, u8 *last_sense)
 936 {
 937         struct gendisk *disk = cdi->disk;
 938         u32 len = nr * CD_FRAMESIZE_RAW;
 939         struct scsi_cmnd *scmd;
 940         struct request *rq;
 941         struct bio *bio;
 942         int ret;
 943
 944         rq = scsi_alloc_request(disk->queue, REQ_OP_DRV_IN, 0);
 945         if (IS_ERR(rq))
 946                 return PTR_ERR(rq);
 947         scmd = blk_mq_rq_to_pdu(rq);
 948
 949         ret = blk_rq_map_user(disk->queue, rq, NULL, ubuf, len, GFP_KERNEL);
 950         if (ret)
 951                 goto out_put_request;
 952
 953         scmd->cmnd[0] = GPCMD_READ_CD;
 954         scmd->cmnd[1] = 1 << 2;
 955         scmd->cmnd[2] = (lba >> 24) & 0xff;
 956         scmd->cmnd[3] = (lba >> 16) & 0xff;
 957         scmd->cmnd[4] = (lba >>  8) & 0xff;
 958         scmd->cmnd[5] = lba & 0xff;
 959         scmd->cmnd[6] = (nr >> 16) & 0xff;
 960         scmd->cmnd[7] = (nr >>  8) & 0xff;
 961         scmd->cmnd[8] = nr & 0xff;
 962         scmd->cmnd[9] = 0xf8;
 963         scmd->cmd_len = 12;
 964         rq->timeout = 60 * HZ;
 965         bio = rq->bio;
 966
 967         blk_execute_rq(rq, false);
 968         if (scmd->result) {
 969                 struct scsi_sense_hdr sshdr;
 970
 971                 scsi_normalize_sense(scmd->sense_buffer, scmd->sense_len,
 972                                      &sshdr);
 973                 *last_sense = sshdr.sense_key;
 974                 ret = -EIO;
 975         }
 976
 977         if (blk_rq_unmap_user(bio))
 978                 ret = -EFAULT;
 979 out_put_request:
 980         blk_mq_free_request(rq);
 981         return ret;
 982 }
 983
 984 static int sr_remove(struct device *dev)
 985 {
 986         struct scsi_cd *cd = dev_get_drvdata(dev);
 987
 988         scsi_autopm_get_device(cd->device);
 989
 990         del_gendisk(cd->disk);
 991         put_disk(cd->disk);
 992
 993         return 0;
 994 }
 995
 996 static int __init init_sr(void)
 997 {
 998         int rc;
 999
1000         rc = register_blkdev(SCSI_CDROM_MAJOR, "sr");
1001         if (rc)
1002                 return rc;
1003         rc = scsi_register_driver(&sr_template.gendrv);
1004         if (rc)
1005                 unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
1006
1007         return rc;
1008 }
1009
1010 static void __exit exit_sr(void)
1011 {
1012         scsi_unregister_driver(&sr_template.gendrv);
1013         unregister_blkdev(SCSI_CDROM_MAJOR, "sr");
1014 }
1015
1016 module_init(init_sr);
1017 module_exit(exit_sr);
1018 MODULE_LICENSE("GPL");