drivers/ide/ide-cd.c

   1 /*
   2  * ATAPI CD-ROM driver.
   3  *
   4  * Copyright (C) 1994-1996   Scott Snyder <snyder@fnald0.fnal.gov>
   5  * Copyright (C) 1996-1998   Erik Andersen <andersee@debian.org>
   6  * Copyright (C) 1998-2000   Jens Axboe <axboe@suse.de>
   7  * Copyright (C) 2005, 2007-2009  Bartlomiej Zolnierkiewicz
   8  *
   9  * May be copied or modified under the terms of the GNU General Public
  10  * License.  See linux/COPYING for more information.
  11  *
  12  * See Documentation/cdrom/ide-cd for usage information.
  13  *
  14  * Suggestions are welcome. Patches that work are more welcome though. ;-)
  15  *
  16  * Documentation:
  17  *      Mt. Fuji (SFF8090 version 4) and ATAPI (SFF-8020i rev 2.6) standards.
  18  *
  19  * For historical changelog please see:
  20  *      Documentation/ide/ChangeLog.ide-cd.1994-2004
  21  */
  22
  23 #define DRV_NAME "ide-cd"
  24 #define PFX DRV_NAME ": "
  25
  26 #define IDECD_VERSION "5.00"
  27
  28 #include <linux/module.h>
  29 #include <linux/types.h>
  30 #include <linux/kernel.h>
  31 #include <linux/delay.h>
  32 #include <linux/timer.h>
  33 #include <linux/seq_file.h>
  34 #include <linux/slab.h>
  35 #include <linux/interrupt.h>
  36 #include <linux/errno.h>
  37 #include <linux/cdrom.h>
  38 #include <linux/ide.h>
  39 #include <linux/completion.h>
  40 #include <linux/mutex.h>
  41 #include <linux/bcd.h>
  42
  43 /* For SCSI -> ATAPI command conversion */
  44 #include <scsi/scsi.h>
  45
  46 #include <linux/io.h>
  47 #include <asm/byteorder.h>
  48 #include <linux/uaccess.h>
  49 #include <asm/unaligned.h>
  50
  51 #include "ide-cd.h"
  52
  53 static DEFINE_MUTEX(ide_cd_mutex);
  54 static DEFINE_MUTEX(idecd_ref_mutex);
  55
  56 static void ide_cd_release(struct device *);
  57
  58 static struct cdrom_info *ide_cd_get(struct gendisk *disk)
  59 {
  60         struct cdrom_info *cd = NULL;
  61
  62         mutex_lock(&idecd_ref_mutex);
  63         cd = ide_drv_g(disk, cdrom_info);
  64         if (cd) {
  65                 if (ide_device_get(cd->drive))
  66                         cd = NULL;
  67                 else
  68                         get_device(&cd->dev);
  69
  70         }
  71         mutex_unlock(&idecd_ref_mutex);
  72         return cd;
  73 }
  74
  75 static void ide_cd_put(struct cdrom_info *cd)
  76 {
  77         ide_drive_t *drive = cd->drive;
  78
  79         mutex_lock(&idecd_ref_mutex);
  80         put_device(&cd->dev);
  81         ide_device_put(drive);
  82         mutex_unlock(&idecd_ref_mutex);
  83 }
  84
  85 /*
  86  * Generic packet command support and error handling routines.
  87  */
  88
  89 /* Mark that we've seen a media change and invalidate our internal buffers. */
  90 static void cdrom_saw_media_change(ide_drive_t *drive)
  91 {
  92         drive->dev_flags |= IDE_DFLAG_MEDIA_CHANGED;
  93         drive->atapi_flags &= ~IDE_AFLAG_TOC_VALID;
  94 }
  95
  96 static int cdrom_log_sense(ide_drive_t *drive, struct request *rq)
  97 {
  98         struct request_sense *sense = &drive->sense_data;
  99         int log = 0;
 100
 101         if (!sense || !rq || (rq->cmd_flags & REQ_QUIET))
 102                 return 0;
 103
 104         ide_debug_log(IDE_DBG_SENSE, "sense_key: 0x%x", sense->sense_key);
 105
 106         switch (sense->sense_key) {
 107         case NO_SENSE:
 108         case RECOVERED_ERROR:
 109                 break;
 110         case NOT_READY:
 111                 /*
 112                  * don't care about tray state messages for e.g. capacity
 113                  * commands or in-progress or becoming ready
 114                  */
 115                 if (sense->asc == 0x3a || sense->asc == 0x04)
 116                         break;
 117                 log = 1;
 118                 break;
 119         case ILLEGAL_REQUEST:
 120                 /*
 121                  * don't log START_STOP unit with LoEj set, since we cannot
 122                  * reliably check if drive can auto-close
 123                  */
 124                 if (rq->cmd[0] == GPCMD_START_STOP_UNIT && sense->asc == 0x24)
 125                         break;
 126                 log = 1;
 127                 break;
 128         case UNIT_ATTENTION:
 129                 /*
 130                  * Make good and sure we've seen this potential media change.
 131                  * Some drives (i.e. Creative) fail to present the correct sense
 132                  * key in the error register.
 133                  */
 134                 cdrom_saw_media_change(drive);
 135                 break;
 136         default:
 137                 log = 1;
 138                 break;
 139         }
 140         return log;
 141 }
 142
 143 static void cdrom_analyze_sense_data(ide_drive_t *drive,
 144                                      struct request *failed_command)
 145 {
 146         struct request_sense *sense = &drive->sense_data;
 147         struct cdrom_info *info = drive->driver_data;
 148         unsigned long sector;
 149         unsigned long bio_sectors;
 150
 151         ide_debug_log(IDE_DBG_SENSE, "error_code: 0x%x, sense_key: 0x%x",
 152                                      sense->error_code, sense->sense_key);
 153
 154         if (failed_command)
 155                 ide_debug_log(IDE_DBG_SENSE, "failed cmd: 0x%x",
 156                                              failed_command->cmd[0]);
 157
 158         if (!cdrom_log_sense(drive, failed_command))
 159                 return;
 160
 161         /*
 162          * If a read toc is executed for a CD-R or CD-RW medium where the first
 163          * toc has not been recorded yet, it will fail with 05/24/00 (which is a
 164          * confusing error)
 165          */
 166         if (failed_command && failed_command->cmd[0] == GPCMD_READ_TOC_PMA_ATIP)
 167                 if (sense->sense_key == 0x05 && sense->asc == 0x24)
 168                         return;
 169
 170         /* current error */
 171         if (sense->error_code == 0x70) {
 172                 switch (sense->sense_key) {
 173                 case MEDIUM_ERROR:
 174                 case VOLUME_OVERFLOW:
 175                 case ILLEGAL_REQUEST:
 176                         if (!sense->valid)
 177                                 break;
 178                         if (failed_command == NULL ||
 179                             failed_command->cmd_type != REQ_TYPE_FS)
 180                                 break;
 181                         sector = (sense->information[0] << 24) |
 182                                  (sense->information[1] << 16) |
 183                                  (sense->information[2] <<  8) |
 184                                  (sense->information[3]);
 185
 186                         if (queue_logical_block_size(drive->queue) == 2048)
 187                                 /* device sector size is 2K */
 188                                 sector <<= 2;
 189
 190                         bio_sectors = max(bio_sectors(failed_command->bio), 4U);
 191                         sector &= ~(bio_sectors - 1);
 192
 193                         /*
 194                          * The SCSI specification allows for the value
 195                          * returned by READ CAPACITY to be up to 75 2K
 196                          * sectors past the last readable block.
 197                          * Therefore, if we hit a medium error within the
 198                          * last 75 2K sectors, we decrease the saved size
 199                          * value.
 200                          */
 201                         if (sector < get_capacity(info->disk) &&
 202                             drive->probed_capacity - sector < 4 * 75)
 203                                 set_capacity(info->disk, sector);
 204                 }
 205         }
 206
 207         ide_cd_log_error(drive->name, failed_command, sense);
 208 }
 209
 210 static void ide_cd_complete_failed_rq(ide_drive_t *drive, struct request *rq)
 211 {
 212         /*
 213          * For REQ_TYPE_SENSE, "rq->special" points to the original
 214          * failed request.  Also, the sense data should be read
 215          * directly from rq which might be different from the original
 216          * sense buffer if it got copied during mapping.
 217          */
 218         struct request *failed = (struct request *)rq->special;
 219         void *sense = bio_data(rq->bio);
 220
 221         if (failed) {
 222                 if (failed->sense) {
 223                         /*
 224                          * Sense is always read into drive->sense_data.
 225                          * Copy back if the failed request has its
 226                          * sense pointer set.
 227                          */
 228                         memcpy(failed->sense, sense, 18);
 229                         failed->sense_len = rq->sense_len;
 230                 }
 231                 cdrom_analyze_sense_data(drive, failed);
 232
 233                 if (ide_end_rq(drive, failed, -EIO, blk_rq_bytes(failed)))
 234                         BUG();
 235         } else
 236                 cdrom_analyze_sense_data(drive, NULL);
 237 }
 238
 239
 240 /*
 241  * Allow the drive 5 seconds to recover; some devices will return NOT_READY
 242  * while flushing data from cache.
 243  *
 244  * returns: 0 failed (write timeout expired)
 245  *          1 success
 246  */
 247 static int ide_cd_breathe(ide_drive_t *drive, struct request *rq)
 248 {
 249
 250         struct cdrom_info *info = drive->driver_data;
 251
 252         if (!rq->errors)
 253                 info->write_timeout = jiffies + ATAPI_WAIT_WRITE_BUSY;
 254
 255         rq->errors = 1;
 256
 257         if (time_after(jiffies, info->write_timeout))
 258                 return 0;
 259         else {
 260                 /*
 261                  * take a breather
 262                  */
 263                 blk_delay_queue(drive->queue, 1);
 264                 return 1;
 265         }
 266 }
 267
 268 /**
 269  * Returns:
 270  * 0: if the request should be continued.
 271  * 1: if the request will be going through error recovery.
 272  * 2: if the request should be ended.
 273  */
 274 static int cdrom_decode_status(ide_drive_t *drive, u8 stat)
 275 {
 276         ide_hwif_t *hwif = drive->hwif;
 277         struct request *rq = hwif->rq;
 278         int err, sense_key, do_end_request = 0;
 279
 280         /* get the IDE error register */
 281         err = ide_read_error(drive);
 282         sense_key = err >> 4;
 283
 284         ide_debug_log(IDE_DBG_RQ, "cmd: 0x%x, rq->cmd_type: 0x%x, err: 0x%x, "
 285                                   "stat 0x%x",
 286                                   rq->cmd[0], rq->cmd_type, err, stat);
 287
 288         if (rq->cmd_type == REQ_TYPE_SENSE) {
 289                 /*
 290                  * We got an error trying to get sense info from the drive
 291                  * (probably while trying to recover from a former error).
 292                  * Just give up.
 293                  */
 294                 rq->cmd_flags |= REQ_FAILED;
 295                 return 2;
 296         }
 297
 298         /* if we have an error, pass CHECK_CONDITION as the SCSI status byte */
 299         if (rq->cmd_type == REQ_TYPE_BLOCK_PC && !rq->errors)
 300                 rq->errors = SAM_STAT_CHECK_CONDITION;
 301
 302         if (blk_noretry_request(rq))
 303                 do_end_request = 1;
 304
 305         switch (sense_key) {
 306         case NOT_READY:
 307                 if (rq->cmd_type == REQ_TYPE_FS && rq_data_dir(rq) == WRITE) {
 308                         if (ide_cd_breathe(drive, rq))
 309                                 return 1;
 310                 } else {
 311                         cdrom_saw_media_change(drive);
 312
 313                         if (rq->cmd_type == REQ_TYPE_FS &&
 314                             !(rq->cmd_flags & REQ_QUIET))
 315                                 printk(KERN_ERR PFX "%s: tray open\n",
 316                                         drive->name);
 317                 }
 318                 do_end_request = 1;
 319                 break;
 320         case UNIT_ATTENTION:
 321                 cdrom_saw_media_change(drive);
 322
 323                 if (rq->cmd_type != REQ_TYPE_FS)
 324                         return 0;
 325
 326                 /*
 327                  * Arrange to retry the request but be sure to give up if we've
 328                  * retried too many times.
 329                  */
 330                 if (++rq->errors > ERROR_MAX)
 331                         do_end_request = 1;
 332                 break;
 333         case ILLEGAL_REQUEST:
 334                 /*
 335                  * Don't print error message for this condition -- SFF8090i
 336                  * indicates that 5/24/00 is the correct response to a request
 337                  * to close the tray if the drive doesn't have that capability.
 338                  *
 339                  * cdrom_log_sense() knows this!
 340                  */
 341                 if (rq->cmd[0] == GPCMD_START_STOP_UNIT)
 342                         break;
 343                 /* fall-through */
 344         case DATA_PROTECT:
 345                 /*
 346                  * No point in retrying after an illegal request or data
 347                  * protect error.
 348                  */
 349                 if (!(rq->cmd_flags & REQ_QUIET))
 350                         ide_dump_status(drive, "command error", stat);
 351                 do_end_request = 1;
 352                 break;
 353         case MEDIUM_ERROR:
 354                 /*
 355                  * No point in re-trying a zillion times on a bad sector.
 356                  * If we got here the error is not correctable.
 357                  */
 358                 if (!(rq->cmd_flags & REQ_QUIET))
 359                         ide_dump_status(drive, "media error "
 360                                         "(bad sector)", stat);
 361                 do_end_request = 1;
 362                 break;
 363         case BLANK_CHECK:
 364                 /* disk appears blank? */
 365                 if (!(rq->cmd_flags & REQ_QUIET))
 366                         ide_dump_status(drive, "media error (blank)",
 367                                         stat);
 368                 do_end_request = 1;
 369                 break;
 370         default:
 371                 if (rq->cmd_type != REQ_TYPE_FS)
 372                         break;
 373                 if (err & ~ATA_ABORTED) {
 374                         /* go to the default handler for other errors */
 375                         ide_error(drive, "cdrom_decode_status", stat);
 376                         return 1;
 377                 } else if (++rq->errors > ERROR_MAX)
 378                         /* we've racked up too many retries, abort */
 379                         do_end_request = 1;
 380         }
 381
 382         if (rq->cmd_type != REQ_TYPE_FS) {
 383                 rq->cmd_flags |= REQ_FAILED;
 384                 do_end_request = 1;
 385         }
 386
 387         /*
 388          * End a request through request sense analysis when we have sense data.
 389          * We need this in order to perform end of media processing.
 390          */
 391         if (do_end_request)
 392                 goto end_request;
 393
 394         /* if we got a CHECK_CONDITION status, queue a request sense command */
 395         if (stat & ATA_ERR)
 396                 return ide_queue_sense_rq(drive, NULL) ? 2 : 1;
 397         return 1;
 398
 399 end_request:
 400         if (stat & ATA_ERR) {
 401                 hwif->rq = NULL;
 402                 return ide_queue_sense_rq(drive, rq) ? 2 : 1;
 403         } else
 404                 return 2;
 405 }
 406
 407 static void ide_cd_request_sense_fixup(ide_drive_t *drive, struct ide_cmd *cmd)
 408 {
 409         struct request *rq = cmd->rq;
 410
 411         ide_debug_log(IDE_DBG_FUNC, "rq->cmd[0]: 0x%x", rq->cmd[0]);
 412
 413         /*
 414          * Some of the trailing request sense fields are optional,
 415          * and some drives don't send them.  Sigh.
 416          */
 417         if (rq->cmd[0] == GPCMD_REQUEST_SENSE &&
 418             cmd->nleft > 0 && cmd->nleft <= 5)
 419                 cmd->nleft = 0;
 420 }
 421
 422 int ide_cd_queue_pc(ide_drive_t *drive, const unsigned char *cmd,
 423                     int write, void *buffer, unsigned *bufflen,
 424                     struct request_sense *sense, int timeout,
 425                     unsigned int cmd_flags)
 426 {
 427         struct cdrom_info *info = drive->driver_data;
 428         struct request_sense local_sense;
 429         int retries = 10;
 430         unsigned int flags = 0;
 431
 432         if (!sense)
 433                 sense = &local_sense;
 434
 435         ide_debug_log(IDE_DBG_PC, "cmd[0]: 0x%x, write: 0x%x, timeout: %d, "
 436                                   "cmd_flags: 0x%x",
 437                                   cmd[0], write, timeout, cmd_flags);
 438
 439         /* start of retry loop */
 440         do {
 441                 struct request *rq;
 442                 int error;
 443
 444                 rq = blk_get_request(drive->queue, write, __GFP_WAIT);
 445
 446                 memcpy(rq->cmd, cmd, BLK_MAX_CDB);
 447                 rq->cmd_type = REQ_TYPE_ATA_PC;
 448                 rq->sense = sense;
 449                 rq->cmd_flags |= cmd_flags;
 450                 rq->timeout = timeout;
 451                 if (buffer) {
 452                         error = blk_rq_map_kern(drive->queue, rq, buffer,
 453                                                 *bufflen, GFP_NOIO);
 454                         if (error) {
 455                                 blk_put_request(rq);
 456                                 return error;
 457                         }
 458                 }
 459
 460                 error = blk_execute_rq(drive->queue, info->disk, rq, 0);
 461
 462                 if (buffer)
 463                         *bufflen = rq->resid_len;
 464
 465                 flags = rq->cmd_flags;
 466                 blk_put_request(rq);
 467
 468                 /*
 469                  * FIXME: we should probably abort/retry or something in case of
 470                  * failure.
 471                  */
 472                 if (flags & REQ_FAILED) {
 473                         /*
 474                          * The request failed.  Retry if it was due to a unit
 475                          * attention status (usually means media was changed).
 476                          */
 477                         struct request_sense *reqbuf = sense;
 478
 479                         if (reqbuf->sense_key == UNIT_ATTENTION)
 480                                 cdrom_saw_media_change(drive);
 481                         else if (reqbuf->sense_key == NOT_READY &&
 482                                  reqbuf->asc == 4 && reqbuf->ascq != 4) {
 483                                 /*
 484                                  * The drive is in the process of loading
 485                                  * a disk.  Retry, but wait a little to give
 486                                  * the drive time to complete the load.
 487                                  */
 488                                 ssleep(2);
 489                         } else {
 490                                 /* otherwise, don't retry */
 491                                 retries = 0;
 492                         }
 493                         --retries;
 494                 }
 495
 496                 /* end of retry loop */
 497         } while ((flags & REQ_FAILED) && retries >= 0);
 498
 499         /* return an error if the command failed */
 500         return (flags & REQ_FAILED) ? -EIO : 0;
 501 }
 502
 503 /*
 504  * returns true if rq has been completed
 505  */
 506 static bool ide_cd_error_cmd(ide_drive_t *drive, struct ide_cmd *cmd)
 507 {
 508         unsigned int nr_bytes = cmd->nbytes - cmd->nleft;
 509
 510         if (cmd->tf_flags & IDE_TFLAG_WRITE)
 511                 nr_bytes -= cmd->last_xfer_len;
 512
 513         if (nr_bytes > 0) {
 514                 ide_complete_rq(drive, 0, nr_bytes);
 515                 return true;
 516         }
 517
 518         return false;
 519 }
 520
 521 static ide_startstop_t cdrom_newpc_intr(ide_drive_t *drive)
 522 {
 523         ide_hwif_t *hwif = drive->hwif;
 524         struct ide_cmd *cmd = &hwif->cmd;
 525         struct request *rq = hwif->rq;
 526         ide_expiry_t *expiry = NULL;
 527         int dma_error = 0, dma, thislen, uptodate = 0;
 528         int write = (rq_data_dir(rq) == WRITE) ? 1 : 0, rc = 0;
 529         int sense = (rq->cmd_type == REQ_TYPE_SENSE);
 530         unsigned int timeout;
 531         u16 len;
 532         u8 ireason, stat;
 533
 534         ide_debug_log(IDE_DBG_PC, "cmd: 0x%x, write: 0x%x", rq->cmd[0], write);
 535
 536         /* check for errors */
 537         dma = drive->dma;
 538         if (dma) {
 539                 drive->dma = 0;
 540                 drive->waiting_for_dma = 0;
 541                 dma_error = hwif->dma_ops->dma_end(drive);
 542                 ide_dma_unmap_sg(drive, cmd);
 543                 if (dma_error) {
 544                         printk(KERN_ERR PFX "%s: DMA %s error\n", drive->name,
 545                                         write ? "write" : "read");
 546                         ide_dma_off(drive);
 547                 }
 548         }
 549
 550         /* check status */
 551         stat = hwif->tp_ops->read_status(hwif);
 552
 553         if (!OK_STAT(stat, 0, BAD_R_STAT)) {
 554                 rc = cdrom_decode_status(drive, stat);
 555                 if (rc) {
 556                         if (rc == 2)
 557                                 goto out_end;
 558                         return ide_stopped;
 559                 }
 560         }
 561
 562         /* using dma, transfer is complete now */
 563         if (dma) {
 564                 if (dma_error)
 565                         return ide_error(drive, "dma error", stat);
 566                 uptodate = 1;
 567                 goto out_end;
 568         }
 569
 570         ide_read_bcount_and_ireason(drive, &len, &ireason);
 571
 572         thislen = (rq->cmd_type == REQ_TYPE_FS) ? len : cmd->nleft;
 573         if (thislen > len)
 574                 thislen = len;
 575
 576         ide_debug_log(IDE_DBG_PC, "DRQ: stat: 0x%x, thislen: %d",
 577                                   stat, thislen);
 578
 579         /* If DRQ is clear, the command has completed. */
 580         if ((stat & ATA_DRQ) == 0) {
 581                 if (rq->cmd_type == REQ_TYPE_FS) {
 582                         /*
 583                          * If we're not done reading/writing, complain.
 584                          * Otherwise, complete the command normally.
 585                          */
 586                         uptodate = 1;
 587                         if (cmd->nleft > 0) {
 588                                 printk(KERN_ERR PFX "%s: %s: data underrun "
 589                                         "(%u bytes)\n", drive->name, __func__,
 590                                         cmd->nleft);
 591                                 if (!write)
 592                                         rq->cmd_flags |= REQ_FAILED;
 593                                 uptodate = 0;
 594                         }
 595                 } else if (rq->cmd_type != REQ_TYPE_BLOCK_PC) {
 596                         ide_cd_request_sense_fixup(drive, cmd);
 597
 598                         uptodate = cmd->nleft ? 0 : 1;
 599
 600                         /*
 601                          * suck out the remaining bytes from the drive in an
 602                          * attempt to complete the data xfer. (see BZ#13399)
 603                          */
 604                         if (!(stat & ATA_ERR) && !uptodate && thislen) {
 605                                 ide_pio_bytes(drive, cmd, write, thislen);
 606                                 uptodate = cmd->nleft ? 0 : 1;
 607                         }
 608
 609                         if (!uptodate)
 610                                 rq->cmd_flags |= REQ_FAILED;
 611                 }
 612                 goto out_end;
 613         }
 614
 615         rc = ide_check_ireason(drive, rq, len, ireason, write);
 616         if (rc)
 617                 goto out_end;
 618
 619         cmd->last_xfer_len = 0;
 620
 621         ide_debug_log(IDE_DBG_PC, "data transfer, rq->cmd_type: 0x%x, "
 622                                   "ireason: 0x%x",
 623                                   rq->cmd_type, ireason);
 624
 625         /* transfer data */
 626         while (thislen > 0) {
 627                 int blen = min_t(int, thislen, cmd->nleft);
 628
 629                 if (cmd->nleft == 0)
 630                         break;
 631
 632                 ide_pio_bytes(drive, cmd, write, blen);
 633                 cmd->last_xfer_len += blen;
 634
 635                 thislen -= blen;
 636                 len -= blen;
 637
 638                 if (sense && write == 0)
 639                         rq->sense_len += blen;
 640         }
 641
 642         /* pad, if necessary */
 643         if (len > 0) {
 644                 if (rq->cmd_type != REQ_TYPE_FS || write == 0)
 645                         ide_pad_transfer(drive, write, len);
 646                 else {
 647                         printk(KERN_ERR PFX "%s: confused, missing data\n",
 648                                 drive->name);
 649                         blk_dump_rq_flags(rq, "cdrom_newpc_intr");
 650                 }
 651         }
 652
 653         if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
 654                 timeout = rq->timeout;
 655         } else {
 656                 timeout = ATAPI_WAIT_PC;
 657                 if (rq->cmd_type != REQ_TYPE_FS)
 658                         expiry = ide_cd_expiry;
 659         }
 660
 661         hwif->expiry = expiry;
 662         ide_set_handler(drive, cdrom_newpc_intr, timeout);
 663         return ide_started;
 664
 665 out_end:
 666         if (rq->cmd_type == REQ_TYPE_BLOCK_PC && rc == 0) {
 667                 rq->resid_len = 0;
 668                 blk_end_request_all(rq, 0);
 669                 hwif->rq = NULL;
 670         } else {
 671                 if (sense && uptodate)
 672                         ide_cd_complete_failed_rq(drive, rq);
 673
 674                 if (rq->cmd_type == REQ_TYPE_FS) {
 675                         if (cmd->nleft == 0)
 676                                 uptodate = 1;
 677                 } else {
 678                         if (uptodate <= 0 && rq->errors == 0)
 679                                 rq->errors = -EIO;
 680                 }
 681
 682                 if (uptodate == 0 && rq->bio)
 683                         if (ide_cd_error_cmd(drive, cmd))
 684                                 return ide_stopped;
 685
 686                 /* make sure it's fully ended */
 687                 if (rq->cmd_type != REQ_TYPE_FS) {
 688                         rq->resid_len -= cmd->nbytes - cmd->nleft;
 689                         if (uptodate == 0 && (cmd->tf_flags & IDE_TFLAG_WRITE))
 690                                 rq->resid_len += cmd->last_xfer_len;
 691                 }
 692
 693                 ide_complete_rq(drive, uptodate ? 0 : -EIO, blk_rq_bytes(rq));
 694
 695                 if (sense && rc == 2)
 696                         ide_error(drive, "request sense failure", stat);
 697         }
 698         return ide_stopped;
 699 }
 700
 701 static ide_startstop_t cdrom_start_rw(ide_drive_t *drive, struct request *rq)
 702 {
 703         struct cdrom_info *cd = drive->driver_data;
 704         struct request_queue *q = drive->queue;
 705         int write = rq_data_dir(rq) == WRITE;
 706         unsigned short sectors_per_frame =
 707                 queue_logical_block_size(q) >> SECTOR_BITS;
 708
 709         ide_debug_log(IDE_DBG_RQ, "rq->cmd[0]: 0x%x, rq->cmd_flags: 0x%x, "
 710                                   "secs_per_frame: %u",
 711                                   rq->cmd[0], rq->cmd_flags, sectors_per_frame);
 712
 713         if (write) {
 714                 /* disk has become write protected */
 715                 if (get_disk_ro(cd->disk))
 716                         return ide_stopped;
 717         } else {
 718                 /*
 719                  * We may be retrying this request after an error.  Fix up any
 720                  * weirdness which might be present in the request packet.
 721                  */
 722                 q->prep_rq_fn(q, rq);
 723         }
 724
 725         /* fs requests *must* be hardware frame aligned */
 726         if ((blk_rq_sectors(rq) & (sectors_per_frame - 1)) ||
 727             (blk_rq_pos(rq) & (sectors_per_frame - 1)))
 728                 return ide_stopped;
 729
 730         /* use DMA, if possible */
 731         drive->dma = !!(drive->dev_flags & IDE_DFLAG_USING_DMA);
 732
 733         if (write)
 734                 cd->devinfo.media_written = 1;
 735
 736         rq->timeout = ATAPI_WAIT_PC;
 737
 738         return ide_started;
 739 }
 740
 741 static void cdrom_do_block_pc(ide_drive_t *drive, struct request *rq)
 742 {
 743
 744         ide_debug_log(IDE_DBG_PC, "rq->cmd[0]: 0x%x, rq->cmd_type: 0x%x",
 745                                   rq->cmd[0], rq->cmd_type);
 746
 747         if (rq->cmd_type == REQ_TYPE_BLOCK_PC)
 748                 rq->cmd_flags |= REQ_QUIET;
 749         else
 750                 rq->cmd_flags &= ~REQ_FAILED;
 751
 752         drive->dma = 0;
 753
 754         /* sg request */
 755         if (rq->bio) {
 756                 struct request_queue *q = drive->queue;
 757                 char *buf = bio_data(rq->bio);
 758                 unsigned int alignment;
 759
 760                 drive->dma = !!(drive->dev_flags & IDE_DFLAG_USING_DMA);
 761
 762                 /*
 763                  * check if dma is safe
 764                  *
 765                  * NOTE! The "len" and "addr" checks should possibly have
 766                  * separate masks.
 767                  */
 768                 alignment = queue_dma_alignment(q) | q->dma_pad_mask;
 769                 if ((unsigned long)buf & alignment
 770                     || blk_rq_bytes(rq) & q->dma_pad_mask
 771                     || object_is_on_stack(buf))
 772                         drive->dma = 0;
 773         }
 774 }
 775
 776 static ide_startstop_t ide_cd_do_request(ide_drive_t *drive, struct request *rq,
 777                                         sector_t block)
 778 {
 779         struct ide_cmd cmd;
 780         int uptodate = 0;
 781         unsigned int nsectors;
 782
 783         ide_debug_log(IDE_DBG_RQ, "cmd: 0x%x, block: %llu",
 784                                   rq->cmd[0], (unsigned long long)block);
 785
 786         if (drive->debug_mask & IDE_DBG_RQ)
 787                 blk_dump_rq_flags(rq, "ide_cd_do_request");
 788
 789         switch (rq->cmd_type) {
 790         case REQ_TYPE_FS:
 791                 if (cdrom_start_rw(drive, rq) == ide_stopped)
 792                         goto out_end;
 793                 break;
 794         case REQ_TYPE_SENSE:
 795         case REQ_TYPE_BLOCK_PC:
 796         case REQ_TYPE_ATA_PC:
 797                 if (!rq->timeout)
 798                         rq->timeout = ATAPI_WAIT_PC;
 799
 800                 cdrom_do_block_pc(drive, rq);
 801                 break;
 802         case REQ_TYPE_SPECIAL:
 803                 /* right now this can only be a reset... */
 804                 uptodate = 1;
 805                 goto out_end;
 806         default:
 807                 BUG();
 808         }
 809
 810         /* prepare sense request for this command */
 811         ide_prep_sense(drive, rq);
 812
 813         memset(&cmd, 0, sizeof(cmd));
 814
 815         if (rq_data_dir(rq))
 816                 cmd.tf_flags |= IDE_TFLAG_WRITE;
 817
 818         cmd.rq = rq;
 819
 820         if (rq->cmd_type == REQ_TYPE_FS || blk_rq_bytes(rq)) {
 821                 ide_init_sg_cmd(&cmd, blk_rq_bytes(rq));
 822                 ide_map_sg(drive, &cmd);
 823         }
 824
 825         return ide_issue_pc(drive, &cmd);
 826 out_end:
 827         nsectors = blk_rq_sectors(rq);
 828
 829         if (nsectors == 0)
 830                 nsectors = 1;
 831
 832         ide_complete_rq(drive, uptodate ? 0 : -EIO, nsectors << 9);
 833
 834         return ide_stopped;
 835 }
 836
 837 /*
 838  * Ioctl handling.
 839  *
 840  * Routines which queue packet commands take as a final argument a pointer to a
 841  * request_sense struct. If execution of the command results in an error with a
 842  * CHECK CONDITION status, this structure will be filled with the results of the
 843  * subsequent request sense command. The pointer can also be NULL, in which case
 844  * no sense information is returned.
 845  */
 846 static void msf_from_bcd(struct atapi_msf *msf)
 847 {
 848         msf->minute = bcd2bin(msf->minute);
 849         msf->second = bcd2bin(msf->second);
 850         msf->frame  = bcd2bin(msf->frame);
 851 }
 852
 853 int cdrom_check_status(ide_drive_t *drive, struct request_sense *sense)
 854 {
 855         struct cdrom_info *info = drive->driver_data;
 856         struct cdrom_device_info *cdi = &info->devinfo;
 857         unsigned char cmd[BLK_MAX_CDB];
 858
 859         ide_debug_log(IDE_DBG_FUNC, "enter");
 860
 861         memset(cmd, 0, BLK_MAX_CDB);
 862         cmd[0] = GPCMD_TEST_UNIT_READY;
 863
 864         /*
 865          * Sanyo 3 CD changer uses byte 7 of TEST_UNIT_READY to switch CDs
 866          * instead of supporting the LOAD_UNLOAD opcode.
 867          */
 868         cmd[7] = cdi->sanyo_slot % 3;
 869
 870         return ide_cd_queue_pc(drive, cmd, 0, NULL, NULL, sense, 0, REQ_QUIET);
 871 }
 872
 873 static int cdrom_read_capacity(ide_drive_t *drive, unsigned long *capacity,
 874                                unsigned long *sectors_per_frame,
 875                                struct request_sense *sense)
 876 {
 877         struct {
 878                 __be32 lba;
 879                 __be32 blocklen;
 880         } capbuf;
 881
 882         int stat;
 883         unsigned char cmd[BLK_MAX_CDB];
 884         unsigned len = sizeof(capbuf);
 885         u32 blocklen;
 886
 887         ide_debug_log(IDE_DBG_FUNC, "enter");
 888
 889         memset(cmd, 0, BLK_MAX_CDB);
 890         cmd[0] = GPCMD_READ_CDVD_CAPACITY;
 891
 892         stat = ide_cd_queue_pc(drive, cmd, 0, &capbuf, &len, sense, 0,
 893                                REQ_QUIET);
 894         if (stat)
 895                 return stat;
 896
 897         /*
 898          * Sanity check the given block size, in so far as making
 899          * sure the sectors_per_frame we give to the caller won't
 900          * end up being bogus.
 901          */
 902         blocklen = be32_to_cpu(capbuf.blocklen);
 903         blocklen = (blocklen >> SECTOR_BITS) << SECTOR_BITS;
 904         switch (blocklen) {
 905         case 512:
 906         case 1024:
 907         case 2048:
 908         case 4096:
 909                 break;
 910         default:
 911                 printk_once(KERN_ERR PFX "%s: weird block size %u; "
 912                                 "setting default block size to 2048\n",
 913                                 drive->name, blocklen);
 914                 blocklen = 2048;
 915                 break;
 916         }
 917
 918         *capacity = 1 + be32_to_cpu(capbuf.lba);
 919         *sectors_per_frame = blocklen >> SECTOR_BITS;
 920
 921         ide_debug_log(IDE_DBG_PROBE, "cap: %lu, sectors_per_frame: %lu",
 922                                      *capacity, *sectors_per_frame);
 923
 924         return 0;
 925 }
 926
 927 static int cdrom_read_tocentry(ide_drive_t *drive, int trackno, int msf_flag,
 928                                 int format, char *buf, int buflen,
 929                                 struct request_sense *sense)
 930 {
 931         unsigned char cmd[BLK_MAX_CDB];
 932
 933         ide_debug_log(IDE_DBG_FUNC, "enter");
 934
 935         memset(cmd, 0, BLK_MAX_CDB);
 936
 937         cmd[0] = GPCMD_READ_TOC_PMA_ATIP;
 938         cmd[6] = trackno;
 939         cmd[7] = (buflen >> 8);
 940         cmd[8] = (buflen & 0xff);
 941         cmd[9] = (format << 6);
 942
 943         if (msf_flag)
 944                 cmd[1] = 2;
 945
 946         return ide_cd_queue_pc(drive, cmd, 0, buf, &buflen, sense, 0, REQ_QUIET);
 947 }
 948
 949 /* Try to read the entire TOC for the disk into our internal buffer. */
 950 int ide_cd_read_toc(ide_drive_t *drive, struct request_sense *sense)
 951 {
 952         int stat, ntracks, i;
 953         struct cdrom_info *info = drive->driver_data;
 954         struct cdrom_device_info *cdi = &info->devinfo;
 955         struct atapi_toc *toc = info->toc;
 956         struct {
 957                 struct atapi_toc_header hdr;
 958                 struct atapi_toc_entry  ent;
 959         } ms_tmp;
 960         long last_written;
 961         unsigned long sectors_per_frame = SECTORS_PER_FRAME;
 962
 963         ide_debug_log(IDE_DBG_FUNC, "enter");
 964
 965         if (toc == NULL) {
 966                 /* try to allocate space */
 967                 toc = kmalloc(sizeof(struct atapi_toc), GFP_KERNEL);
 968                 if (toc == NULL) {
 969                         printk(KERN_ERR PFX "%s: No cdrom TOC buffer!\n",
 970                                         drive->name);
 971                         return -ENOMEM;
 972                 }
 973                 info->toc = toc;
 974         }
 975
 976         /*
 977          * Check to see if the existing data is still valid. If it is,
 978          * just return.
 979          */
 980         (void) cdrom_check_status(drive, sense);
 981
 982         if (drive->atapi_flags & IDE_AFLAG_TOC_VALID)
 983                 return 0;
 984
 985         /* try to get the total cdrom capacity and sector size */
 986         stat = cdrom_read_capacity(drive, &toc->capacity, &sectors_per_frame,
 987                                    sense);
 988         if (stat)
 989                 toc->capacity = 0x1fffff;
 990
 991         set_capacity(info->disk, toc->capacity * sectors_per_frame);
 992         /* save a private copy of the TOC capacity for error handling */
 993         drive->probed_capacity = toc->capacity * sectors_per_frame;
 994
 995         blk_queue_logical_block_size(drive->queue,
 996                                      sectors_per_frame << SECTOR_BITS);
 997
 998         /* first read just the header, so we know how long the TOC is */
 999         stat = cdrom_read_tocentry(drive, 0, 1, 0, (char *) &toc->hdr,
1000                                     sizeof(struct atapi_toc_header), sense);
1001         if (stat)
1002                 return stat;
1003
1004         if (drive->atapi_flags & IDE_AFLAG_TOCTRACKS_AS_BCD) {
1005                 toc->hdr.first_track = bcd2bin(toc->hdr.first_track);
1006                 toc->hdr.last_track  = bcd2bin(toc->hdr.last_track);
1007         }
1008
1009         ntracks = toc->hdr.last_track - toc->hdr.first_track + 1;
1010         if (ntracks <= 0)
1011                 return -EIO;
1012         if (ntracks > MAX_TRACKS)
1013                 ntracks = MAX_TRACKS;
1014
1015         /* now read the whole schmeer */
1016         stat = cdrom_read_tocentry(drive, toc->hdr.first_track, 1, 0,
1017                                   (char *)&toc->hdr,
1018                                    sizeof(struct atapi_toc_header) +
1019                                    (ntracks + 1) *
1020                                    sizeof(struct atapi_toc_entry), sense);
1021
1022         if (stat && toc->hdr.first_track > 1) {
1023                 /*
1024                  * Cds with CDI tracks only don't have any TOC entries, despite
1025                  * of this the returned values are
1026                  * first_track == last_track = number of CDI tracks + 1,
1027                  * so that this case is indistinguishable from the same layout
1028                  * plus an additional audio track. If we get an error for the
1029                  * regular case, we assume a CDI without additional audio
1030                  * tracks. In this case the readable TOC is empty (CDI tracks
1031                  * are not included) and only holds the Leadout entry.
1032                  *
1033                  * Heiko Eißfeldt.
1034                  */
1035                 ntracks = 0;
1036                 stat = cdrom_read_tocentry(drive, CDROM_LEADOUT, 1, 0,
1037                                            (char *)&toc->hdr,
1038                                            sizeof(struct atapi_toc_header) +
1039                                            (ntracks + 1) *
1040                                            sizeof(struct atapi_toc_entry),
1041                                            sense);
1042                 if (stat)
1043                         return stat;
1044
1045                 if (drive->atapi_flags & IDE_AFLAG_TOCTRACKS_AS_BCD) {
1046                         toc->hdr.first_track = (u8)bin2bcd(CDROM_LEADOUT);
1047                         toc->hdr.last_track = (u8)bin2bcd(CDROM_LEADOUT);
1048                 } else {
1049                         toc->hdr.first_track = CDROM_LEADOUT;
1050                         toc->hdr.last_track = CDROM_LEADOUT;
1051                 }
1052         }
1053
1054         if (stat)
1055                 return stat;
1056
1057         toc->hdr.toc_length = be16_to_cpu(toc->hdr.toc_length);
1058
1059         if (drive->atapi_flags & IDE_AFLAG_TOCTRACKS_AS_BCD) {
1060                 toc->hdr.first_track = bcd2bin(toc->hdr.first_track);
1061                 toc->hdr.last_track  = bcd2bin(toc->hdr.last_track);
1062         }
1063
1064         for (i = 0; i <= ntracks; i++) {
1065                 if (drive->atapi_flags & IDE_AFLAG_TOCADDR_AS_BCD) {
1066                         if (drive->atapi_flags & IDE_AFLAG_TOCTRACKS_AS_BCD)
1067                                 toc->ent[i].track = bcd2bin(toc->ent[i].track);
1068                         msf_from_bcd(&toc->ent[i].addr.msf);
1069                 }
1070                 toc->ent[i].addr.lba = msf_to_lba(toc->ent[i].addr.msf.minute,
1071                                                   toc->ent[i].addr.msf.second,
1072                                                   toc->ent[i].addr.msf.frame);
1073         }
1074
1075         if (toc->hdr.first_track != CDROM_LEADOUT) {
1076                 /* read the multisession information */
1077                 stat = cdrom_read_tocentry(drive, 0, 0, 1, (char *)&ms_tmp,
1078                                            sizeof(ms_tmp), sense);
1079                 if (stat)
1080                         return stat;
1081
1082                 toc->last_session_lba = be32_to_cpu(ms_tmp.ent.addr.lba);
1083         } else {
1084                 ms_tmp.hdr.last_track = CDROM_LEADOUT;
1085                 ms_tmp.hdr.first_track = ms_tmp.hdr.last_track;
1086                 toc->last_session_lba = msf_to_lba(0, 2, 0); /* 0m 2s 0f */
1087         }
1088
1089         if (drive->atapi_flags & IDE_AFLAG_TOCADDR_AS_BCD) {
1090                 /* re-read multisession information using MSF format */
1091                 stat = cdrom_read_tocentry(drive, 0, 1, 1, (char *)&ms_tmp,
1092                                            sizeof(ms_tmp), sense);
1093                 if (stat)
1094                         return stat;
1095
1096                 msf_from_bcd(&ms_tmp.ent.addr.msf);
1097                 toc->last_session_lba = msf_to_lba(ms_tmp.ent.addr.msf.minute,
1098                                                    ms_tmp.ent.addr.msf.second,
1099                                                    ms_tmp.ent.addr.msf.frame);
1100         }
1101
1102         toc->xa_flag = (ms_tmp.hdr.first_track != ms_tmp.hdr.last_track);
1103
1104         /* now try to get the total cdrom capacity */
1105         stat = cdrom_get_last_written(cdi, &last_written);
1106         if (!stat && (last_written > toc->capacity)) {
1107                 toc->capacity = last_written;
1108                 set_capacity(info->disk, toc->capacity * sectors_per_frame);
1109                 drive->probed_capacity = toc->capacity * sectors_per_frame;
1110         }
1111
1112         /* Remember that we've read this stuff. */
1113         drive->atapi_flags |= IDE_AFLAG_TOC_VALID;
1114
1115         return 0;
1116 }
1117
1118 int ide_cdrom_get_capabilities(ide_drive_t *drive, u8 *buf)
1119 {
1120         struct cdrom_info *info = drive->driver_data;
1121         struct cdrom_device_info *cdi = &info->devinfo;
1122         struct packet_command cgc;
1123         int stat, attempts = 3, size = ATAPI_CAPABILITIES_PAGE_SIZE;
1124
1125         ide_debug_log(IDE_DBG_FUNC, "enter");
1126
1127         if ((drive->atapi_flags & IDE_AFLAG_FULL_CAPS_PAGE) == 0)
1128                 size -= ATAPI_CAPABILITIES_PAGE_PAD_SIZE;
1129
1130         init_cdrom_command(&cgc, buf, size, CGC_DATA_UNKNOWN);
1131         do {
1132                 /* we seem to get stat=0x01,err=0x00 the first time (??) */
1133                 stat = cdrom_mode_sense(cdi, &cgc, GPMODE_CAPABILITIES_PAGE, 0);
1134                 if (!stat)
1135                         break;
1136         } while (--attempts);
1137         return stat;
1138 }
1139
1140 void ide_cdrom_update_speed(ide_drive_t *drive, u8 *buf)
1141 {
1142         struct cdrom_info *cd = drive->driver_data;
1143         u16 curspeed, maxspeed;
1144
1145         ide_debug_log(IDE_DBG_FUNC, "enter");
1146
1147         if (drive->atapi_flags & IDE_AFLAG_LE_SPEED_FIELDS) {
1148                 curspeed = le16_to_cpup((__le16 *)&buf[8 + 14]);
1149                 maxspeed = le16_to_cpup((__le16 *)&buf[8 + 8]);
1150         } else {
1151                 curspeed = be16_to_cpup((__be16 *)&buf[8 + 14]);
1152                 maxspeed = be16_to_cpup((__be16 *)&buf[8 + 8]);
1153         }
1154
1155         ide_debug_log(IDE_DBG_PROBE, "curspeed: %u, maxspeed: %u",
1156                                      curspeed, maxspeed);
1157
1158         cd->current_speed = DIV_ROUND_CLOSEST(curspeed, 176);
1159         cd->max_speed = DIV_ROUND_CLOSEST(maxspeed, 176);
1160 }
1161
1162 #define IDE_CD_CAPABILITIES \
1163         (CDC_CLOSE_TRAY | CDC_OPEN_TRAY | CDC_LOCK | CDC_SELECT_SPEED | \
1164          CDC_SELECT_DISC | CDC_MULTI_SESSION | CDC_MCN | CDC_MEDIA_CHANGED | \
1165          CDC_PLAY_AUDIO | CDC_RESET | CDC_DRIVE_STATUS | CDC_CD_R | \
1166          CDC_CD_RW | CDC_DVD | CDC_DVD_R | CDC_DVD_RAM | CDC_GENERIC_PACKET | \
1167          CDC_MO_DRIVE | CDC_MRW | CDC_MRW_W | CDC_RAM)
1168
1169 static struct cdrom_device_ops ide_cdrom_dops = {
1170         .open                   = ide_cdrom_open_real,
1171         .release                = ide_cdrom_release_real,
1172         .drive_status           = ide_cdrom_drive_status,
1173         .check_events           = ide_cdrom_check_events_real,
1174         .tray_move              = ide_cdrom_tray_move,
1175         .lock_door              = ide_cdrom_lock_door,
1176         .select_speed           = ide_cdrom_select_speed,
1177         .get_last_session       = ide_cdrom_get_last_session,
1178         .get_mcn                = ide_cdrom_get_mcn,
1179         .reset                  = ide_cdrom_reset,
1180         .audio_ioctl            = ide_cdrom_audio_ioctl,
1181         .capability             = IDE_CD_CAPABILITIES,
1182         .generic_packet         = ide_cdrom_packet,
1183 };
1184
1185 static int ide_cdrom_register(ide_drive_t *drive, int nslots)
1186 {
1187         struct cdrom_info *info = drive->driver_data;
1188         struct cdrom_device_info *devinfo = &info->devinfo;
1189
1190         ide_debug_log(IDE_DBG_PROBE, "nslots: %d", nslots);
1191
1192         devinfo->ops = &ide_cdrom_dops;
1193         devinfo->speed = info->current_speed;
1194         devinfo->capacity = nslots;
1195         devinfo->handle = drive;
1196         strcpy(devinfo->name, drive->name);
1197
1198         if (drive->atapi_flags & IDE_AFLAG_NO_SPEED_SELECT)
1199                 devinfo->mask |= CDC_SELECT_SPEED;
1200
1201         devinfo->disk = info->disk;
1202         return register_cdrom(devinfo);
1203 }
1204
1205 static int ide_cdrom_probe_capabilities(ide_drive_t *drive)
1206 {
1207         struct cdrom_info *cd = drive->driver_data;
1208         struct cdrom_device_info *cdi = &cd->devinfo;
1209         u8 buf[ATAPI_CAPABILITIES_PAGE_SIZE];
1210         mechtype_t mechtype;
1211         int nslots = 1;
1212
1213         ide_debug_log(IDE_DBG_PROBE, "media: 0x%x, atapi_flags: 0x%lx",
1214                                      drive->media, drive->atapi_flags);
1215
1216         cdi->mask = (CDC_CD_R | CDC_CD_RW | CDC_DVD | CDC_DVD_R |
1217                      CDC_DVD_RAM | CDC_SELECT_DISC | CDC_PLAY_AUDIO |
1218                      CDC_MO_DRIVE | CDC_RAM);
1219
1220         if (drive->media == ide_optical) {
1221                 cdi->mask &= ~(CDC_MO_DRIVE | CDC_RAM);
1222                 printk(KERN_ERR PFX "%s: ATAPI magneto-optical drive\n",
1223                                 drive->name);
1224                 return nslots;
1225         }
1226
1227         if (drive->atapi_flags & IDE_AFLAG_PRE_ATAPI12) {
1228                 drive->atapi_flags &= ~IDE_AFLAG_NO_EJECT;
1229                 cdi->mask &= ~CDC_PLAY_AUDIO;
1230                 return nslots;
1231         }
1232
1233         /*
1234          * We have to cheat a little here. the packet will eventually be queued
1235          * with ide_cdrom_packet(), which extracts the drive from cdi->handle.
1236          * Since this device hasn't been registered with the Uniform layer yet,
1237          * it can't do this. Same goes for cdi->ops.
1238          */
1239         cdi->handle = drive;
1240         cdi->ops = &ide_cdrom_dops;
1241
1242         if (ide_cdrom_get_capabilities(drive, buf))
1243                 return 0;
1244
1245         if ((buf[8 + 6] & 0x01) == 0)
1246                 drive->dev_flags &= ~IDE_DFLAG_DOORLOCKING;
1247         if (buf[8 + 6] & 0x08)
1248                 drive->atapi_flags &= ~IDE_AFLAG_NO_EJECT;
1249         if (buf[8 + 3] & 0x01)
1250                 cdi->mask &= ~CDC_CD_R;
1251         if (buf[8 + 3] & 0x02)
1252                 cdi->mask &= ~(CDC_CD_RW | CDC_RAM);
1253         if (buf[8 + 2] & 0x38)
1254                 cdi->mask &= ~CDC_DVD;
1255         if (buf[8 + 3] & 0x20)
1256                 cdi->mask &= ~(CDC_DVD_RAM | CDC_RAM);
1257         if (buf[8 + 3] & 0x10)
1258                 cdi->mask &= ~CDC_DVD_R;
1259         if ((buf[8 + 4] & 0x01) || (drive->atapi_flags & IDE_AFLAG_PLAY_AUDIO_OK))
1260                 cdi->mask &= ~CDC_PLAY_AUDIO;
1261
1262         mechtype = buf[8 + 6] >> 5;
1263         if (mechtype == mechtype_caddy ||
1264             mechtype == mechtype_popup ||
1265             (drive->atapi_flags & IDE_AFLAG_NO_AUTOCLOSE))
1266                 cdi->mask |= CDC_CLOSE_TRAY;
1267
1268         if (cdi->sanyo_slot > 0) {
1269                 cdi->mask &= ~CDC_SELECT_DISC;
1270                 nslots = 3;
1271         } else if (mechtype == mechtype_individual_changer ||
1272                    mechtype == mechtype_cartridge_changer) {
1273                 nslots = cdrom_number_of_slots(cdi);
1274                 if (nslots > 1)
1275                         cdi->mask &= ~CDC_SELECT_DISC;
1276         }
1277
1278         ide_cdrom_update_speed(drive, buf);
1279
1280         printk(KERN_INFO PFX "%s: ATAPI", drive->name);
1281
1282         /* don't print speed if the drive reported 0 */
1283         if (cd->max_speed)
1284                 printk(KERN_CONT " %dX", cd->max_speed);
1285
1286         printk(KERN_CONT " %s", (cdi->mask & CDC_DVD) ? "CD-ROM" : "DVD-ROM");
1287
1288         if ((cdi->mask & CDC_DVD_R) == 0 || (cdi->mask & CDC_DVD_RAM) == 0)
1289                 printk(KERN_CONT " DVD%s%s",
1290                                  (cdi->mask & CDC_DVD_R) ? "" : "-R",
1291                                  (cdi->mask & CDC_DVD_RAM) ? "" : "/RAM");
1292
1293         if ((cdi->mask & CDC_CD_R) == 0 || (cdi->mask & CDC_CD_RW) == 0)
1294                 printk(KERN_CONT " CD%s%s",
1295                                  (cdi->mask & CDC_CD_R) ? "" : "-R",
1296                                  (cdi->mask & CDC_CD_RW) ? "" : "/RW");
1297
1298         if ((cdi->mask & CDC_SELECT_DISC) == 0)
1299                 printk(KERN_CONT " changer w/%d slots", nslots);
1300         else
1301                 printk(KERN_CONT " drive");
1302
1303         printk(KERN_CONT ", %dkB Cache\n",
1304                          be16_to_cpup((__be16 *)&buf[8 + 12]));
1305
1306         return nslots;
1307 }
1308
1309 /* standard prep_rq_fn that builds 10 byte cmds */
1310 static int ide_cdrom_prep_fs(struct request_queue *q, struct request *rq)
1311 {
1312         int hard_sect = queue_logical_block_size(q);
1313         long block = (long)blk_rq_pos(rq) / (hard_sect >> 9);
1314         unsigned long blocks = blk_rq_sectors(rq) / (hard_sect >> 9);
1315
1316         memset(rq->cmd, 0, BLK_MAX_CDB);
1317
1318         if (rq_data_dir(rq) == READ)
1319                 rq->cmd[0] = GPCMD_READ_10;
1320         else
1321                 rq->cmd[0] = GPCMD_WRITE_10;
1322
1323         /*
1324          * fill in lba
1325          */
1326         rq->cmd[2] = (block >> 24) & 0xff;
1327         rq->cmd[3] = (block >> 16) & 0xff;
1328         rq->cmd[4] = (block >>  8) & 0xff;
1329         rq->cmd[5] = block & 0xff;
1330
1331         /*
1332          * and transfer length
1333          */
1334         rq->cmd[7] = (blocks >> 8) & 0xff;
1335         rq->cmd[8] = blocks & 0xff;
1336         rq->cmd_len = 10;
1337         return BLKPREP_OK;
1338 }
1339
1340 /*
1341  * Most of the SCSI commands are supported directly by ATAPI devices.
1342  * This transform handles the few exceptions.
1343  */
1344 static int ide_cdrom_prep_pc(struct request *rq)
1345 {
1346         u8 *c = rq->cmd;
1347
1348         /* transform 6-byte read/write commands to the 10-byte version */
1349         if (c[0] == READ_6 || c[0] == WRITE_6) {
1350                 c[8] = c[4];
1351                 c[5] = c[3];
1352                 c[4] = c[2];
1353                 c[3] = c[1] & 0x1f;
1354                 c[2] = 0;
1355                 c[1] &= 0xe0;
1356                 c[0] += (READ_10 - READ_6);
1357                 rq->cmd_len = 10;
1358                 return BLKPREP_OK;
1359         }
1360
1361         /*
1362          * it's silly to pretend we understand 6-byte sense commands, just
1363          * reject with ILLEGAL_REQUEST and the caller should take the
1364          * appropriate action
1365          */
1366         if (c[0] == MODE_SENSE || c[0] == MODE_SELECT) {
1367                 rq->errors = ILLEGAL_REQUEST;
1368                 return BLKPREP_KILL;
1369         }
1370
1371         return BLKPREP_OK;
1372 }
1373
1374 static int ide_cdrom_prep_fn(struct request_queue *q, struct request *rq)
1375 {
1376         if (rq->cmd_type == REQ_TYPE_FS)
1377                 return ide_cdrom_prep_fs(q, rq);
1378         else if (rq->cmd_type == REQ_TYPE_BLOCK_PC)
1379                 return ide_cdrom_prep_pc(rq);
1380
1381         return 0;
1382 }
1383
1384 struct cd_list_entry {
1385         const char      *id_model;
1386         const char      *id_firmware;
1387         unsigned int    cd_flags;
1388 };
1389
1390 #ifdef CONFIG_IDE_PROC_FS
1391 static sector_t ide_cdrom_capacity(ide_drive_t *drive)
1392 {
1393         unsigned long capacity, sectors_per_frame;
1394
1395         if (cdrom_read_capacity(drive, &capacity, &sectors_per_frame, NULL))
1396                 return 0;
1397
1398         return capacity * sectors_per_frame;
1399 }
1400
1401 static int idecd_capacity_proc_show(struct seq_file *m, void *v)
1402 {
1403         ide_drive_t *drive = m->private;
1404
1405         seq_printf(m, "%llu\n", (long long)ide_cdrom_capacity(drive));
1406         return 0;
1407 }
1408
1409 static int idecd_capacity_proc_open(struct inode *inode, struct file *file)
1410 {
1411         return single_open(file, idecd_capacity_proc_show, PDE_DATA(inode));
1412 }
1413
1414 static const struct file_operations idecd_capacity_proc_fops = {
1415         .owner          = THIS_MODULE,
1416         .open           = idecd_capacity_proc_open,
1417         .read           = seq_read,
1418         .llseek         = seq_lseek,
1419         .release        = single_release,
1420 };
1421
1422 static ide_proc_entry_t idecd_proc[] = {
1423         { "capacity", S_IFREG|S_IRUGO, &idecd_capacity_proc_fops },
1424         {}
1425 };
1426
1427 static ide_proc_entry_t *ide_cd_proc_entries(ide_drive_t *drive)
1428 {
1429         return idecd_proc;
1430 }
1431
1432 static const struct ide_proc_devset *ide_cd_proc_devsets(ide_drive_t *drive)
1433 {
1434         return NULL;
1435 }
1436 #endif
1437
1438 static const struct cd_list_entry ide_cd_quirks_list[] = {
1439         /* SCR-3231 doesn't support the SET_CD_SPEED command. */
1440         { "SAMSUNG CD-ROM SCR-3231", NULL,   IDE_AFLAG_NO_SPEED_SELECT       },
1441         /* Old NEC260 (not R) was released before ATAPI 1.2 spec. */
1442         { "NEC CD-ROM DRIVE:260",    "1.01", IDE_AFLAG_TOCADDR_AS_BCD |
1443                                              IDE_AFLAG_PRE_ATAPI12,          },
1444         /* Vertos 300, some versions of this drive like to talk BCD. */
1445         { "V003S0DS",                NULL,   IDE_AFLAG_VERTOS_300_SSD,       },
1446         /* Vertos 600 ESD. */
1447         { "V006E0DS",                NULL,   IDE_AFLAG_VERTOS_600_ESD,       },
1448         /*
1449          * Sanyo 3 CD changer uses a non-standard command for CD changing
1450          * (by default standard ATAPI support for CD changers is used).
1451          */
1452         { "CD-ROM CDR-C3 G",         NULL,   IDE_AFLAG_SANYO_3CD             },
1453         { "CD-ROM CDR-C3G",          NULL,   IDE_AFLAG_SANYO_3CD             },
1454         { "CD-ROM CDR_C36",          NULL,   IDE_AFLAG_SANYO_3CD             },
1455         /* Stingray 8X CD-ROM. */
1456         { "STINGRAY 8422 IDE 8X CD-ROM 7-27-95", NULL, IDE_AFLAG_PRE_ATAPI12 },
1457         /*
1458          * ACER 50X CD-ROM and WPI 32X CD-ROM require the full spec length
1459          * mode sense page capabilities size, but older drives break.
1460          */
1461         { "ATAPI CD ROM DRIVE 50X MAX", NULL,   IDE_AFLAG_FULL_CAPS_PAGE     },
1462         { "WPI CDS-32X",                NULL,   IDE_AFLAG_FULL_CAPS_PAGE     },
1463         /* ACER/AOpen 24X CD-ROM has the speed fields byte-swapped. */
1464         { "",                        "241N", IDE_AFLAG_LE_SPEED_FIELDS       },
1465         /*
1466          * Some drives used by Apple don't advertise audio play
1467          * but they do support reading TOC & audio datas.
1468          */
1469         { "MATSHITADVD-ROM SR-8187", NULL,   IDE_AFLAG_PLAY_AUDIO_OK         },
1470         { "MATSHITADVD-ROM SR-8186", NULL,   IDE_AFLAG_PLAY_AUDIO_OK         },
1471         { "MATSHITADVD-ROM SR-8176", NULL,   IDE_AFLAG_PLAY_AUDIO_OK         },
1472         { "MATSHITADVD-ROM SR-8174", NULL,   IDE_AFLAG_PLAY_AUDIO_OK         },
1473         { "Optiarc DVD RW AD-5200A", NULL,   IDE_AFLAG_PLAY_AUDIO_OK         },
1474         { "Optiarc DVD RW AD-7200A", NULL,   IDE_AFLAG_PLAY_AUDIO_OK         },
1475         { "Optiarc DVD RW AD-7543A", NULL,   IDE_AFLAG_NO_AUTOCLOSE          },
1476         { "TEAC CD-ROM CD-224E",     NULL,   IDE_AFLAG_NO_AUTOCLOSE          },
1477         { NULL, NULL, 0 }
1478 };
1479
1480 static unsigned int ide_cd_flags(u16 *id)
1481 {
1482         const struct cd_list_entry *cle = ide_cd_quirks_list;
1483
1484         while (cle->id_model) {
1485                 if (strcmp(cle->id_model, (char *)&id[ATA_ID_PROD]) == 0 &&
1486                     (cle->id_firmware == NULL ||
1487                      strstr((char *)&id[ATA_ID_FW_REV], cle->id_firmware)))
1488                         return cle->cd_flags;
1489                 cle++;
1490         }
1491
1492         return 0;
1493 }
1494
1495 static int ide_cdrom_setup(ide_drive_t *drive)
1496 {
1497         struct cdrom_info *cd = drive->driver_data;
1498         struct cdrom_device_info *cdi = &cd->devinfo;
1499         struct request_queue *q = drive->queue;
1500         u16 *id = drive->id;
1501         char *fw_rev = (char *)&id[ATA_ID_FW_REV];
1502         int nslots;
1503
1504         ide_debug_log(IDE_DBG_PROBE, "enter");
1505
1506         blk_queue_prep_rq(q, ide_cdrom_prep_fn);
1507         blk_queue_dma_alignment(q, 31);
1508         blk_queue_update_dma_pad(q, 15);
1509
1510         drive->dev_flags |= IDE_DFLAG_MEDIA_CHANGED;
1511         drive->atapi_flags = IDE_AFLAG_NO_EJECT | ide_cd_flags(id);
1512
1513         if ((drive->atapi_flags & IDE_AFLAG_VERTOS_300_SSD) &&
1514             fw_rev[4] == '1' && fw_rev[6] <= '2')
1515                 drive->atapi_flags |= (IDE_AFLAG_TOCTRACKS_AS_BCD |
1516                                      IDE_AFLAG_TOCADDR_AS_BCD);
1517         else if ((drive->atapi_flags & IDE_AFLAG_VERTOS_600_ESD) &&
1518                  fw_rev[4] == '1' && fw_rev[6] <= '2')
1519                 drive->atapi_flags |= IDE_AFLAG_TOCTRACKS_AS_BCD;
1520         else if (drive->atapi_flags & IDE_AFLAG_SANYO_3CD)
1521                 /* 3 => use CD in slot 0 */
1522                 cdi->sanyo_slot = 3;
1523
1524         nslots = ide_cdrom_probe_capabilities(drive);
1525
1526         blk_queue_logical_block_size(q, CD_FRAMESIZE);
1527
1528         if (ide_cdrom_register(drive, nslots)) {
1529                 printk(KERN_ERR PFX "%s: %s failed to register device with the"
1530                                 " cdrom driver.\n", drive->name, __func__);
1531                 cd->devinfo.handle = NULL;
1532                 return 1;
1533         }
1534
1535         ide_proc_register_driver(drive, cd->driver);
1536         return 0;
1537 }
1538
1539 static void ide_cd_remove(ide_drive_t *drive)
1540 {
1541         struct cdrom_info *info = drive->driver_data;
1542
1543         ide_debug_log(IDE_DBG_FUNC, "enter");
1544
1545         ide_proc_unregister_driver(drive, info->driver);
1546         device_del(&info->dev);
1547         del_gendisk(info->disk);
1548
1549         mutex_lock(&idecd_ref_mutex);
1550         put_device(&info->dev);
1551         mutex_unlock(&idecd_ref_mutex);
1552 }
1553
1554 static void ide_cd_release(struct device *dev)
1555 {
1556         struct cdrom_info *info = to_ide_drv(dev, cdrom_info);
1557         struct cdrom_device_info *devinfo = &info->devinfo;
1558         ide_drive_t *drive = info->drive;
1559         struct gendisk *g = info->disk;
1560
1561         ide_debug_log(IDE_DBG_FUNC, "enter");
1562
1563         kfree(info->toc);
1564         if (devinfo->handle == drive)
1565                 unregister_cdrom(devinfo);
1566         drive->driver_data = NULL;
1567         blk_queue_prep_rq(drive->queue, NULL);
1568         g->private_data = NULL;
1569         put_disk(g);
1570         kfree(info);
1571 }
1572
1573 static int ide_cd_probe(ide_drive_t *);
1574
1575 static struct ide_driver ide_cdrom_driver = {
1576         .gen_driver = {
1577                 .owner          = THIS_MODULE,
1578                 .name           = "ide-cdrom",
1579                 .bus            = &ide_bus_type,
1580         },
1581         .probe                  = ide_cd_probe,
1582         .remove                 = ide_cd_remove,
1583         .version                = IDECD_VERSION,
1584         .do_request             = ide_cd_do_request,
1585 #ifdef CONFIG_IDE_PROC_FS
1586         .proc_entries           = ide_cd_proc_entries,
1587         .proc_devsets           = ide_cd_proc_devsets,
1588 #endif
1589 };
1590
1591 static int idecd_open(struct block_device *bdev, fmode_t mode)
1592 {
1593         struct cdrom_info *info;
1594         int rc = -ENXIO;
1595
1596         mutex_lock(&ide_cd_mutex);
1597         info = ide_cd_get(bdev->bd_disk);
1598         if (!info)
1599                 goto out;
1600
1601         rc = cdrom_open(&info->devinfo, bdev, mode);
1602         if (rc < 0)
1603                 ide_cd_put(info);
1604 out:
1605         mutex_unlock(&ide_cd_mutex);
1606         return rc;
1607 }
1608
1609 static void idecd_release(struct gendisk *disk, fmode_t mode)
1610 {
1611         struct cdrom_info *info = ide_drv_g(disk, cdrom_info);
1612
1613         mutex_lock(&ide_cd_mutex);
1614         cdrom_release(&info->devinfo, mode);
1615
1616         ide_cd_put(info);
1617         mutex_unlock(&ide_cd_mutex);
1618 }
1619
1620 static int idecd_set_spindown(struct cdrom_device_info *cdi, unsigned long arg)
1621 {
1622         struct packet_command cgc;
1623         char buffer[16];
1624         int stat;
1625         char spindown;
1626
1627         if (copy_from_user(&spindown, (void __user *)arg, sizeof(char)))
1628                 return -EFAULT;
1629
1630         init_cdrom_command(&cgc, buffer, sizeof(buffer), CGC_DATA_UNKNOWN);
1631
1632         stat = cdrom_mode_sense(cdi, &cgc, GPMODE_CDROM_PAGE, 0);
1633         if (stat)
1634                 return stat;
1635
1636         buffer[11] = (buffer[11] & 0xf0) | (spindown & 0x0f);
1637         return cdrom_mode_select(cdi, &cgc);
1638 }
1639
1640 static int idecd_get_spindown(struct cdrom_device_info *cdi, unsigned long arg)
1641 {
1642         struct packet_command cgc;
1643         char buffer[16];
1644         int stat;
1645         char spindown;
1646
1647         init_cdrom_command(&cgc, buffer, sizeof(buffer), CGC_DATA_UNKNOWN);
1648
1649         stat = cdrom_mode_sense(cdi, &cgc, GPMODE_CDROM_PAGE, 0);
1650         if (stat)
1651                 return stat;
1652
1653         spindown = buffer[11] & 0x0f;
1654         if (copy_to_user((void __user *)arg, &spindown, sizeof(char)))
1655                 return -EFAULT;
1656         return 0;
1657 }
1658
1659 static int idecd_locked_ioctl(struct block_device *bdev, fmode_t mode,
1660                         unsigned int cmd, unsigned long arg)
1661 {
1662         struct cdrom_info *info = ide_drv_g(bdev->bd_disk, cdrom_info);
1663         int err;
1664
1665         switch (cmd) {
1666         case CDROMSETSPINDOWN:
1667                 return idecd_set_spindown(&info->devinfo, arg);
1668         case CDROMGETSPINDOWN:
1669                 return idecd_get_spindown(&info->devinfo, arg);
1670         default:
1671                 break;
1672         }
1673
1674         err = generic_ide_ioctl(info->drive, bdev, cmd, arg);
1675         if (err == -EINVAL)
1676                 err = cdrom_ioctl(&info->devinfo, bdev, mode, cmd, arg);
1677
1678         return err;
1679 }
1680
1681 static int idecd_ioctl(struct block_device *bdev, fmode_t mode,
1682                              unsigned int cmd, unsigned long arg)
1683 {
1684         int ret;
1685
1686         mutex_lock(&ide_cd_mutex);
1687         ret = idecd_locked_ioctl(bdev, mode, cmd, arg);
1688         mutex_unlock(&ide_cd_mutex);
1689
1690         return ret;
1691 }
1692
1693
1694 static unsigned int idecd_check_events(struct gendisk *disk,
1695                                        unsigned int clearing)
1696 {
1697         struct cdrom_info *info = ide_drv_g(disk, cdrom_info);
1698         return cdrom_check_events(&info->devinfo, clearing);
1699 }
1700
1701 static int idecd_revalidate_disk(struct gendisk *disk)
1702 {
1703         struct cdrom_info *info = ide_drv_g(disk, cdrom_info);
1704         struct request_sense sense;
1705
1706         ide_cd_read_toc(info->drive, &sense);
1707
1708         return  0;
1709 }
1710
1711 static const struct block_device_operations idecd_ops = {
1712         .owner                  = THIS_MODULE,
1713         .open                   = idecd_open,
1714         .release                = idecd_release,
1715         .ioctl                  = idecd_ioctl,
1716         .check_events           = idecd_check_events,
1717         .revalidate_disk        = idecd_revalidate_disk
1718 };
1719
1720 /* module options */
1721 static unsigned long debug_mask;
1722 module_param(debug_mask, ulong, 0644);
1723
1724 MODULE_DESCRIPTION("ATAPI CD-ROM Driver");
1725
1726 static int ide_cd_probe(ide_drive_t *drive)
1727 {
1728         struct cdrom_info *info;
1729         struct gendisk *g;
1730         struct request_sense sense;
1731
1732         ide_debug_log(IDE_DBG_PROBE, "driver_req: %s, media: 0x%x",
1733                                      drive->driver_req, drive->media);
1734
1735         if (!strstr("ide-cdrom", drive->driver_req))
1736                 goto failed;
1737
1738         if (drive->media != ide_cdrom && drive->media != ide_optical)
1739                 goto failed;
1740
1741         drive->debug_mask = debug_mask;
1742         drive->irq_handler = cdrom_newpc_intr;
1743
1744         info = kzalloc(sizeof(struct cdrom_info), GFP_KERNEL);
1745         if (info == NULL) {
1746                 printk(KERN_ERR PFX "%s: Can't allocate a cdrom structure\n",
1747                                 drive->name);
1748                 goto failed;
1749         }
1750
1751         g = alloc_disk(1 << PARTN_BITS);
1752         if (!g)
1753                 goto out_free_cd;
1754
1755         ide_init_disk(g, drive);
1756
1757         info->dev.parent = &drive->gendev;
1758         info->dev.release = ide_cd_release;
1759         dev_set_name(&info->dev, "%s", dev_name(&drive->gendev));
1760
1761         if (device_register(&info->dev))
1762                 goto out_free_disk;
1763
1764         info->drive = drive;
1765         info->driver = &ide_cdrom_driver;
1766         info->disk = g;
1767
1768         g->private_data = &info->driver;
1769
1770         drive->driver_data = info;
1771
1772         g->minors = 1;
1773         g->driverfs_dev = &drive->gendev;
1774         g->flags = GENHD_FL_CD | GENHD_FL_REMOVABLE;
1775         if (ide_cdrom_setup(drive)) {
1776                 put_device(&info->dev);
1777                 goto failed;
1778         }
1779
1780         ide_cd_read_toc(drive, &sense);
1781         g->fops = &idecd_ops;
1782         g->flags |= GENHD_FL_REMOVABLE | GENHD_FL_BLOCK_EVENTS_ON_EXCL_WRITE;
1783         add_disk(g);
1784         return 0;
1785
1786 out_free_disk:
1787         put_disk(g);
1788 out_free_cd:
1789         kfree(info);
1790 failed:
1791         return -ENODEV;
1792 }
1793
1794 static void __exit ide_cdrom_exit(void)
1795 {
1796         driver_unregister(&ide_cdrom_driver.gen_driver);
1797 }
1798
1799 static int __init ide_cdrom_init(void)
1800 {
1801         printk(KERN_INFO DRV_NAME " driver " IDECD_VERSION "\n");
1802         return driver_register(&ide_cdrom_driver.gen_driver);
1803 }
1804
1805 MODULE_ALIAS("ide:*m-cdrom*");
1806 MODULE_ALIAS("ide-cd");
1807 module_init(ide_cdrom_init);
1808 module_exit(ide_cdrom_exit);
1809 MODULE_LICENSE("GPL");