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  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  * For those wishing to work on this driver, please be sure you download
  16  * and comply with the latest Mt. Fuji (SFF8090 version 4) and ATAPI
  17  * (SFF-8020i rev 2.6) standards. These documents can be obtained by
  18  * anonymous ftp from:
  19  * ftp://fission.dt.wdc.com/pub/standards/SFF_atapi/spec/SFF8020-r2.6/PS/8020r26.ps
  20  * ftp://ftp.avc-pioneer.com/Mtfuji4/Spec/Fuji4r10.pdf
  21  *
  22  * For historical changelog please see:
  23  *      Documentation/ide/ChangeLog.ide-cd.1994-2004
  24  */
  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/slab.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/errno.h>
  36 #include <linux/cdrom.h>
  37 #include <linux/ide.h>
  38 #include <linux/completion.h>
  39 #include <linux/mutex.h>
  40 #include <linux/bcd.h>
  41
  42 /* For SCSI -> ATAPI command conversion */
  43 #include <scsi/scsi.h>
  44
  45 #include <linux/irq.h>
  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(idecd_ref_mutex);
  54
  55 #define to_ide_cd(obj) container_of(obj, struct cdrom_info, kref)
  56
  57 #define ide_cd_g(disk) \
  58         container_of((disk)->private_data, struct cdrom_info, driver)
  59
  60 static struct cdrom_info *ide_cd_get(struct gendisk *disk)
  61 {
  62         struct cdrom_info *cd = NULL;
  63
  64         mutex_lock(&idecd_ref_mutex);
  65         cd = ide_cd_g(disk);
  66         if (cd)
  67                 kref_get(&cd->kref);
  68         mutex_unlock(&idecd_ref_mutex);
  69         return cd;
  70 }
  71
  72 static void ide_cd_release(struct kref *);
  73
  74 static void ide_cd_put(struct cdrom_info *cd)
  75 {
  76         mutex_lock(&idecd_ref_mutex);
  77         kref_put(&cd->kref, ide_cd_release);
  78         mutex_unlock(&idecd_ref_mutex);
  79 }
  80
  81 /*
  82  * Generic packet command support and error handling routines.
  83  */
  84
  85 /* Mark that we've seen a media change and invalidate our internal buffers. */
  86 static void cdrom_saw_media_change(ide_drive_t *drive)
  87 {
  88         struct cdrom_info *cd = drive->driver_data;
  89
  90         cd->cd_flags |= IDE_CD_FLAG_MEDIA_CHANGED;
  91         cd->cd_flags &= ~IDE_CD_FLAG_TOC_VALID;
  92 }
  93
  94 static int cdrom_log_sense(ide_drive_t *drive, struct request *rq,
  95                            struct request_sense *sense)
  96 {
  97         int log = 0;
  98
  99         if (!sense || !rq || (rq->cmd_flags & REQ_QUIET))
 100                 return 0;
 101
 102         switch (sense->sense_key) {
 103         case NO_SENSE:
 104         case RECOVERED_ERROR:
 105                 break;
 106         case NOT_READY:
 107                 /*
 108                  * don't care about tray state messages for e.g. capacity
 109                  * commands or in-progress or becoming ready
 110                  */
 111                 if (sense->asc == 0x3a || sense->asc == 0x04)
 112                         break;
 113                 log = 1;
 114                 break;
 115         case ILLEGAL_REQUEST:
 116                 /*
 117                  * don't log START_STOP unit with LoEj set, since we cannot
 118                  * reliably check if drive can auto-close
 119                  */
 120                 if (rq->cmd[0] == GPCMD_START_STOP_UNIT && sense->asc == 0x24)
 121                         break;
 122                 log = 1;
 123                 break;
 124         case UNIT_ATTENTION:
 125                 /*
 126                  * Make good and sure we've seen this potential media change.
 127                  * Some drives (i.e. Creative) fail to present the correct sense
 128                  * key in the error register.
 129                  */
 130                 cdrom_saw_media_change(drive);
 131                 break;
 132         default:
 133                 log = 1;
 134                 break;
 135         }
 136         return log;
 137 }
 138
 139 static void cdrom_analyze_sense_data(ide_drive_t *drive,
 140                               struct request *failed_command,
 141                               struct request_sense *sense)
 142 {
 143         unsigned long sector;
 144         unsigned long bio_sectors;
 145         unsigned long valid;
 146         struct cdrom_info *info = drive->driver_data;
 147
 148         if (!cdrom_log_sense(drive, failed_command, sense))
 149                 return;
 150
 151         /*
 152          * If a read toc is executed for a CD-R or CD-RW medium where the first
 153          * toc has not been recorded yet, it will fail with 05/24/00 (which is a
 154          * confusing error)
 155          */
 156         if (failed_command && failed_command->cmd[0] == GPCMD_READ_TOC_PMA_ATIP)
 157                 if (sense->sense_key == 0x05 && sense->asc == 0x24)
 158                         return;
 159
 160         /* current error */
 161         if (sense->error_code == 0x70) {
 162                 switch (sense->sense_key) {
 163                 case MEDIUM_ERROR:
 164                 case VOLUME_OVERFLOW:
 165                 case ILLEGAL_REQUEST:
 166                         if (!sense->valid)
 167                                 break;
 168                         if (failed_command == NULL ||
 169                                         !blk_fs_request(failed_command))
 170                                 break;
 171                         sector = (sense->information[0] << 24) |
 172                                  (sense->information[1] << 16) |
 173                                  (sense->information[2] <<  8) |
 174                                  (sense->information[3]);
 175
 176                         bio_sectors = bio_sectors(failed_command->bio);
 177                         if (bio_sectors < 4)
 178                                 bio_sectors = 4;
 179                         if (drive->queue->hardsect_size == 2048)
 180                                 /* device sector size is 2K */
 181                                 sector <<= 2;
 182                         sector &= ~(bio_sectors - 1);
 183                         valid = (sector - failed_command->sector) << 9;
 184
 185                         if (valid < 0)
 186                                 valid = 0;
 187                         if (sector < get_capacity(info->disk) &&
 188                             drive->probed_capacity - sector < 4 * 75)
 189                                 set_capacity(info->disk, sector);
 190                 }
 191         }
 192
 193         ide_cd_log_error(drive->name, failed_command, sense);
 194 }
 195
 196 /* Initialize a ide-cd packet command request */
 197 void ide_cd_init_rq(ide_drive_t *drive, struct request *rq)
 198 {
 199         struct cdrom_info *cd = drive->driver_data;
 200
 201         ide_init_drive_cmd(rq);
 202         rq->cmd_type = REQ_TYPE_ATA_PC;
 203         rq->rq_disk = cd->disk;
 204 }
 205
 206 static void cdrom_queue_request_sense(ide_drive_t *drive, void *sense,
 207                                       struct request *failed_command)
 208 {
 209         struct cdrom_info *info         = drive->driver_data;
 210         struct request *rq              = &info->request_sense_request;
 211
 212         if (sense == NULL)
 213                 sense = &info->sense_data;
 214
 215         /* stuff the sense request in front of our current request */
 216         ide_cd_init_rq(drive, rq);
 217
 218         rq->data = sense;
 219         rq->cmd[0] = GPCMD_REQUEST_SENSE;
 220         rq->cmd[4] = 18;
 221         rq->data_len = 18;
 222
 223         rq->cmd_type = REQ_TYPE_SENSE;
 224
 225         /* NOTE! Save the failed command in "rq->buffer" */
 226         rq->buffer = (void *) failed_command;
 227
 228         (void) ide_do_drive_cmd(drive, rq, ide_preempt);
 229 }
 230
 231 static void cdrom_end_request(ide_drive_t *drive, int uptodate)
 232 {
 233         struct request *rq = HWGROUP(drive)->rq;
 234         int nsectors = rq->hard_cur_sectors;
 235
 236         if (blk_sense_request(rq) && uptodate) {
 237                 /*
 238                  * For REQ_TYPE_SENSE, "rq->buffer" points to the original
 239                  * failed request
 240                  */
 241                 struct request *failed = (struct request *) rq->buffer;
 242                 struct cdrom_info *info = drive->driver_data;
 243                 void *sense = &info->sense_data;
 244                 unsigned long flags;
 245
 246                 if (failed) {
 247                         if (failed->sense) {
 248                                 sense = failed->sense;
 249                                 failed->sense_len = rq->sense_len;
 250                         }
 251                         cdrom_analyze_sense_data(drive, failed, sense);
 252                         /*
 253                          * now end the failed request
 254                          */
 255                         if (blk_fs_request(failed)) {
 256                                 if (ide_end_dequeued_request(drive, failed, 0,
 257                                                 failed->hard_nr_sectors))
 258                                         BUG();
 259                         } else {
 260                                 spin_lock_irqsave(&ide_lock, flags);
 261                                 if (__blk_end_request(failed, -EIO,
 262                                                       failed->data_len))
 263                                         BUG();
 264                                 spin_unlock_irqrestore(&ide_lock, flags);
 265                         }
 266                 } else
 267                         cdrom_analyze_sense_data(drive, NULL, sense);
 268         }
 269
 270         if (!rq->current_nr_sectors && blk_fs_request(rq))
 271                 uptodate = 1;
 272         /* make sure it's fully ended */
 273         if (blk_pc_request(rq))
 274                 nsectors = (rq->data_len + 511) >> 9;
 275         if (!nsectors)
 276                 nsectors = 1;
 277
 278         ide_end_request(drive, uptodate, nsectors);
 279 }
 280
 281 static void ide_dump_status_no_sense(ide_drive_t *drive, const char *msg, u8 st)
 282 {
 283         if (st & 0x80)
 284                 return;
 285         ide_dump_status(drive, msg, st);
 286 }
 287
 288 /*
 289  * Returns:
 290  * 0: if the request should be continued.
 291  * 1: if the request was ended.
 292  */
 293 static int cdrom_decode_status(ide_drive_t *drive, int good_stat, int *stat_ret)
 294 {
 295         struct request *rq = HWGROUP(drive)->rq;
 296         int stat, err, sense_key;
 297
 298         /* check for errors */
 299         stat = ide_read_status(drive);
 300
 301         if (stat_ret)
 302                 *stat_ret = stat;
 303
 304         if (OK_STAT(stat, good_stat, BAD_R_STAT))
 305                 return 0;
 306
 307         /* get the IDE error register */
 308         err = ide_read_error(drive);
 309         sense_key = err >> 4;
 310
 311         if (rq == NULL) {
 312                 printk(KERN_ERR "%s: missing rq in %s\n",
 313                                 drive->name, __func__);
 314                 return 1;
 315         }
 316
 317         if (blk_sense_request(rq)) {
 318                 /*
 319                  * We got an error trying to get sense info from the drive
 320                  * (probably while trying to recover from a former error).
 321                  * Just give up.
 322                  */
 323                 rq->cmd_flags |= REQ_FAILED;
 324                 cdrom_end_request(drive, 0);
 325                 ide_error(drive, "request sense failure", stat);
 326                 return 1;
 327
 328         } else if (blk_pc_request(rq) || rq->cmd_type == REQ_TYPE_ATA_PC) {
 329                 /* All other functions, except for READ. */
 330
 331                 /*
 332                  * if we have an error, pass back CHECK_CONDITION as the
 333                  * scsi status byte
 334                  */
 335                 if (blk_pc_request(rq) && !rq->errors)
 336                         rq->errors = SAM_STAT_CHECK_CONDITION;
 337
 338                 /* check for tray open */
 339                 if (sense_key == NOT_READY) {
 340                         cdrom_saw_media_change(drive);
 341                 } else if (sense_key == UNIT_ATTENTION) {
 342                         /* check for media change */
 343                         cdrom_saw_media_change(drive);
 344                         return 0;
 345                 } else if (sense_key == ILLEGAL_REQUEST &&
 346                            rq->cmd[0] == GPCMD_START_STOP_UNIT) {
 347                         /*
 348                          * Don't print error message for this condition--
 349                          * SFF8090i indicates that 5/24/00 is the correct
 350                          * response to a request to close the tray if the
 351                          * drive doesn't have that capability.
 352                          * cdrom_log_sense() knows this!
 353                          */
 354                 } else if (!(rq->cmd_flags & REQ_QUIET)) {
 355                         /* otherwise, print an error */
 356                         ide_dump_status(drive, "packet command error", stat);
 357                 }
 358
 359                 rq->cmd_flags |= REQ_FAILED;
 360
 361                 /*
 362                  * instead of playing games with moving completions around,
 363                  * remove failed request completely and end it when the
 364                  * request sense has completed
 365                  */
 366                 goto end_request;
 367
 368         } else if (blk_fs_request(rq)) {
 369                 int do_end_request = 0;
 370
 371                 /* handle errors from READ and WRITE requests */
 372
 373                 if (blk_noretry_request(rq))
 374                         do_end_request = 1;
 375
 376                 if (sense_key == NOT_READY) {
 377                         /* tray open */
 378                         if (rq_data_dir(rq) == READ) {
 379                                 cdrom_saw_media_change(drive);
 380
 381                                 /* fail the request */
 382                                 printk(KERN_ERR "%s: tray open\n", drive->name);
 383                                 do_end_request = 1;
 384                         } else {
 385                                 struct cdrom_info *info = drive->driver_data;
 386
 387                                 /*
 388                                  * Allow the drive 5 seconds to recover, some
 389                                  * devices will return this error while flushing
 390                                  * data from cache.
 391                                  */
 392                                 if (!rq->errors)
 393                                         info->write_timeout = jiffies +
 394                                                         ATAPI_WAIT_WRITE_BUSY;
 395                                 rq->errors = 1;
 396                                 if (time_after(jiffies, info->write_timeout))
 397                                         do_end_request = 1;
 398                                 else {
 399                                         unsigned long flags;
 400
 401                                         /*
 402                                          * take a breather relying on the unplug
 403                                          * timer to kick us again
 404                                          */
 405                                         spin_lock_irqsave(&ide_lock, flags);
 406                                         blk_plug_device(drive->queue);
 407                                         spin_unlock_irqrestore(&ide_lock,
 408                                                                 flags);
 409                                         return 1;
 410                                 }
 411                         }
 412                 } else if (sense_key == UNIT_ATTENTION) {
 413                         /* media change */
 414                         cdrom_saw_media_change(drive);
 415
 416                         /*
 417                          * Arrange to retry the request but be sure to give up
 418                          * if we've retried too many times.
 419                          */
 420                         if (++rq->errors > ERROR_MAX)
 421                                 do_end_request = 1;
 422                 } else if (sense_key == ILLEGAL_REQUEST ||
 423                            sense_key == DATA_PROTECT) {
 424                         /*
 425                          * No point in retrying after an illegal request or data
 426                          * protect error.
 427                          */
 428                         ide_dump_status_no_sense(drive, "command error", stat);
 429                         do_end_request = 1;
 430                 } else if (sense_key == MEDIUM_ERROR) {
 431                         /*
 432                          * No point in re-trying a zillion times on a bad
 433                          * sector. If we got here the error is not correctable.
 434                          */
 435                         ide_dump_status_no_sense(drive,
 436                                                  "media error (bad sector)",
 437                                                  stat);
 438                         do_end_request = 1;
 439                 } else if (sense_key == BLANK_CHECK) {
 440                         /* disk appears blank ?? */
 441                         ide_dump_status_no_sense(drive, "media error (blank)",
 442                                                  stat);
 443                         do_end_request = 1;
 444                 } else if ((err & ~ABRT_ERR) != 0) {
 445                         /* go to the default handler for other errors */
 446                         ide_error(drive, "cdrom_decode_status", stat);
 447                         return 1;
 448                 } else if ((++rq->errors > ERROR_MAX)) {
 449                         /* we've racked up too many retries, abort */
 450                         do_end_request = 1;
 451                 }
 452
 453                 /*
 454                  * End a request through request sense analysis when we have
 455                  * sense data. We need this in order to perform end of media
 456                  * processing.
 457                  */
 458                 if (do_end_request)
 459                         goto end_request;
 460
 461                 /*
 462                  * If we got a CHECK_CONDITION status, queue
 463                  * a request sense command.
 464                  */
 465                 if (stat & ERR_STAT)
 466                         cdrom_queue_request_sense(drive, NULL, NULL);
 467         } else {
 468                 blk_dump_rq_flags(rq, "ide-cd: bad rq");
 469                 cdrom_end_request(drive, 0);
 470         }
 471
 472         /* retry, or handle the next request */
 473         return 1;
 474
 475 end_request:
 476         if (stat & ERR_STAT) {
 477                 unsigned long flags;
 478
 479                 spin_lock_irqsave(&ide_lock, flags);
 480                 blkdev_dequeue_request(rq);
 481                 HWGROUP(drive)->rq = NULL;
 482                 spin_unlock_irqrestore(&ide_lock, flags);
 483
 484                 cdrom_queue_request_sense(drive, rq->sense, rq);
 485         } else
 486                 cdrom_end_request(drive, 0);
 487
 488         return 1;
 489 }
 490
 491 static int cdrom_timer_expiry(ide_drive_t *drive)
 492 {
 493         struct request *rq = HWGROUP(drive)->rq;
 494         unsigned long wait = 0;
 495
 496         /*
 497          * Some commands are *slow* and normally take a long time to complete.
 498          * Usually we can use the ATAPI "disconnect" to bypass this, but not all
 499          * commands/drives support that. Let ide_timer_expiry keep polling us
 500          * for these.
 501          */
 502         switch (rq->cmd[0]) {
 503         case GPCMD_BLANK:
 504         case GPCMD_FORMAT_UNIT:
 505         case GPCMD_RESERVE_RZONE_TRACK:
 506         case GPCMD_CLOSE_TRACK:
 507         case GPCMD_FLUSH_CACHE:
 508                 wait = ATAPI_WAIT_PC;
 509                 break;
 510         default:
 511                 if (!(rq->cmd_flags & REQ_QUIET))
 512                         printk(KERN_INFO "ide-cd: cmd 0x%x timed out\n",
 513                                          rq->cmd[0]);
 514                 wait = 0;
 515                 break;
 516         }
 517         return wait;
 518 }
 519
 520 /*
 521  * Set up the device registers for transferring a packet command on DEV,
 522  * expecting to later transfer XFERLEN bytes.  HANDLER is the routine
 523  * which actually transfers the command to the drive.  If this is a
 524  * drq_interrupt device, this routine will arrange for HANDLER to be
 525  * called when the interrupt from the drive arrives.  Otherwise, HANDLER
 526  * will be called immediately after the drive is prepared for the transfer.
 527  */
 528 static ide_startstop_t cdrom_start_packet_command(ide_drive_t *drive,
 529                                                   int xferlen,
 530                                                   ide_handler_t *handler)
 531 {
 532         ide_startstop_t startstop;
 533         struct cdrom_info *info = drive->driver_data;
 534         ide_hwif_t *hwif = drive->hwif;
 535
 536         /* wait for the controller to be idle */
 537         if (ide_wait_stat(&startstop, drive, 0, BUSY_STAT, WAIT_READY))
 538                 return startstop;
 539
 540         /* FIXME: for Virtual DMA we must check harder */
 541         if (info->dma)
 542                 info->dma = !hwif->dma_ops->dma_setup(drive);
 543
 544         /* set up the controller registers */
 545         ide_pktcmd_tf_load(drive, IDE_TFLAG_OUT_NSECT | IDE_TFLAG_OUT_LBAL |
 546                            IDE_TFLAG_NO_SELECT_MASK, xferlen, info->dma);
 547
 548         if (info->cd_flags & IDE_CD_FLAG_DRQ_INTERRUPT) {
 549                 /* waiting for CDB interrupt, not DMA yet. */
 550                 if (info->dma)
 551                         drive->waiting_for_dma = 0;
 552
 553                 /* packet command */
 554                 ide_execute_command(drive, WIN_PACKETCMD, handler,
 555                                     ATAPI_WAIT_PC, cdrom_timer_expiry);
 556                 return ide_started;
 557         } else {
 558                 unsigned long flags;
 559
 560                 /* packet command */
 561                 spin_lock_irqsave(&ide_lock, flags);
 562                 hwif->OUTBSYNC(drive, WIN_PACKETCMD,
 563                                hwif->io_ports[IDE_COMMAND_OFFSET]);
 564                 ndelay(400);
 565                 spin_unlock_irqrestore(&ide_lock, flags);
 566
 567                 return (*handler) (drive);
 568         }
 569 }
 570
 571 /*
 572  * Send a packet command to DRIVE described by CMD_BUF and CMD_LEN. The device
 573  * registers must have already been prepared by cdrom_start_packet_command.
 574  * HANDLER is the interrupt handler to call when the command completes or
 575  * there's data ready.
 576  */
 577 #define ATAPI_MIN_CDB_BYTES 12
 578 static ide_startstop_t cdrom_transfer_packet_command(ide_drive_t *drive,
 579                                           struct request *rq,
 580                                           ide_handler_t *handler)
 581 {
 582         ide_hwif_t *hwif = drive->hwif;
 583         int cmd_len;
 584         struct cdrom_info *info = drive->driver_data;
 585         ide_startstop_t startstop;
 586
 587         if (info->cd_flags & IDE_CD_FLAG_DRQ_INTERRUPT) {
 588                 /*
 589                  * Here we should have been called after receiving an interrupt
 590                  * from the device.  DRQ should how be set.
 591                  */
 592
 593                 /* check for errors */
 594                 if (cdrom_decode_status(drive, DRQ_STAT, NULL))
 595                         return ide_stopped;
 596
 597                 /* ok, next interrupt will be DMA interrupt */
 598                 if (info->dma)
 599                         drive->waiting_for_dma = 1;
 600         } else {
 601                 /* otherwise, we must wait for DRQ to get set */
 602                 if (ide_wait_stat(&startstop, drive, DRQ_STAT,
 603                                 BUSY_STAT, WAIT_READY))
 604                         return startstop;
 605         }
 606
 607         /* arm the interrupt handler */
 608         ide_set_handler(drive, handler, rq->timeout, cdrom_timer_expiry);
 609
 610         /* ATAPI commands get padded out to 12 bytes minimum */
 611         cmd_len = COMMAND_SIZE(rq->cmd[0]);
 612         if (cmd_len < ATAPI_MIN_CDB_BYTES)
 613                 cmd_len = ATAPI_MIN_CDB_BYTES;
 614
 615         /* send the command to the device */
 616         HWIF(drive)->atapi_output_bytes(drive, rq->cmd, cmd_len);
 617
 618         /* start the DMA if need be */
 619         if (info->dma)
 620                 hwif->dma_ops->dma_start(drive);
 621
 622         return ide_started;
 623 }
 624
 625 /*
 626  * Block read functions.
 627  */
 628 static void ide_cd_pad_transfer(ide_drive_t *drive, xfer_func_t *xf, int len)
 629 {
 630         while (len > 0) {
 631                 int dum = 0;
 632                 xf(drive, &dum, sizeof(dum));
 633                 len -= sizeof(dum);
 634         }
 635 }
 636
 637 static void ide_cd_drain_data(ide_drive_t *drive, int nsects)
 638 {
 639         while (nsects > 0) {
 640                 static char dum[SECTOR_SIZE];
 641
 642                 drive->hwif->atapi_input_bytes(drive, dum, sizeof(dum));
 643                 nsects--;
 644         }
 645 }
 646
 647 /*
 648  * Check the contents of the interrupt reason register from the cdrom
 649  * and attempt to recover if there are problems.  Returns  0 if everything's
 650  * ok; nonzero if the request has been terminated.
 651  */
 652 static int ide_cd_check_ireason(ide_drive_t *drive, struct request *rq,
 653                                 int len, int ireason, int rw)
 654 {
 655         /*
 656          * ireason == 0: the drive wants to receive data from us
 657          * ireason == 2: the drive is expecting to transfer data to us
 658          */
 659         if (ireason == (!rw << 1))
 660                 return 0;
 661         else if (ireason == (rw << 1)) {
 662                 ide_hwif_t *hwif = drive->hwif;
 663                 xfer_func_t *xf;
 664
 665                 /* whoops... */
 666                 printk(KERN_ERR "%s: %s: wrong transfer direction!\n",
 667                                 drive->name, __func__);
 668
 669                 xf = rw ? hwif->atapi_output_bytes : hwif->atapi_input_bytes;
 670                 ide_cd_pad_transfer(drive, xf, len);
 671         } else  if (rw == 0 && ireason == 1) {
 672                 /*
 673                  * Some drives (ASUS) seem to tell us that status info is
 674                  * available.  Just get it and ignore.
 675                  */
 676                 (void)ide_read_status(drive);
 677                 return 0;
 678         } else {
 679                 /* drive wants a command packet, or invalid ireason... */
 680                 printk(KERN_ERR "%s: %s: bad interrupt reason 0x%02x\n",
 681                                 drive->name, __func__, ireason);
 682         }
 683
 684         if (rq->cmd_type == REQ_TYPE_ATA_PC)
 685                 rq->cmd_flags |= REQ_FAILED;
 686
 687         cdrom_end_request(drive, 0);
 688         return -1;
 689 }
 690
 691 /*
 692  * Assume that the drive will always provide data in multiples of at least
 693  * SECTOR_SIZE, as it gets hairy to keep track of the transfers otherwise.
 694  */
 695 static int ide_cd_check_transfer_size(ide_drive_t *drive, int len)
 696 {
 697         struct cdrom_info *cd = drive->driver_data;
 698
 699         if ((len % SECTOR_SIZE) == 0)
 700                 return 0;
 701
 702         printk(KERN_ERR "%s: %s: Bad transfer size %d\n",
 703                         drive->name, __func__, len);
 704
 705         if (cd->cd_flags & IDE_CD_FLAG_LIMIT_NFRAMES)
 706                 printk(KERN_ERR "  This drive is not supported by "
 707                                 "this version of the driver\n");
 708         else {
 709                 printk(KERN_ERR "  Trying to limit transfer sizes\n");
 710                 cd->cd_flags |= IDE_CD_FLAG_LIMIT_NFRAMES;
 711         }
 712
 713         return 1;
 714 }
 715
 716 static ide_startstop_t cdrom_newpc_intr(ide_drive_t *);
 717
 718 /*
 719  * Routine to send a read/write packet command to the drive. This is usually
 720  * called directly from cdrom_start_{read,write}(). However, for drq_interrupt
 721  * devices, it is called from an interrupt when the drive is ready to accept
 722  * the command.
 723  */
 724 static ide_startstop_t cdrom_start_rw_cont(ide_drive_t *drive)
 725 {
 726         struct request *rq = HWGROUP(drive)->rq;
 727
 728         if (rq_data_dir(rq) == READ) {
 729                 unsigned short sectors_per_frame =
 730                         queue_hardsect_size(drive->queue) >> SECTOR_BITS;
 731                 int nskip = rq->sector & (sectors_per_frame - 1);
 732
 733                 /*
 734                  * If the requested sector doesn't start on a frame boundary,
 735                  * we must adjust the start of the transfer so that it does,
 736                  * and remember to skip the first few sectors.
 737                  *
 738                  * If the rq->current_nr_sectors field is larger than the size
 739                  * of the buffer, it will mean that we're to skip a number of
 740                  * sectors equal to the amount by which rq->current_nr_sectors
 741                  * is larger than the buffer size.
 742                  */
 743                 if (nskip > 0) {
 744                         /* sanity check... */
 745                         if (rq->current_nr_sectors !=
 746                             bio_cur_sectors(rq->bio)) {
 747                                 printk(KERN_ERR "%s: %s: buffer botch (%u)\n",
 748                                                 drive->name, __func__,
 749                                                 rq->current_nr_sectors);
 750                                 cdrom_end_request(drive, 0);
 751                                 return ide_stopped;
 752                         }
 753                         rq->current_nr_sectors += nskip;
 754                 }
 755         }
 756 #if 0
 757         else
 758                 /* the immediate bit */
 759                 rq->cmd[1] = 1 << 3;
 760 #endif
 761         /* set up the command */
 762         rq->timeout = ATAPI_WAIT_PC;
 763
 764         /* send the command to the drive and return */
 765         return cdrom_transfer_packet_command(drive, rq, cdrom_newpc_intr);
 766 }
 767
 768 #define IDECD_SEEK_THRESHOLD    (1000)                  /* 1000 blocks */
 769 #define IDECD_SEEK_TIMER        (5 * WAIT_MIN_SLEEP)    /* 100 ms */
 770 #define IDECD_SEEK_TIMEOUT      (2 * WAIT_CMD)          /* 20 sec */
 771
 772 static ide_startstop_t cdrom_seek_intr(ide_drive_t *drive)
 773 {
 774         struct cdrom_info *info = drive->driver_data;
 775         int stat;
 776         static int retry = 10;
 777
 778         if (cdrom_decode_status(drive, 0, &stat))
 779                 return ide_stopped;
 780
 781         info->cd_flags |= IDE_CD_FLAG_SEEKING;
 782
 783         if (retry && time_after(jiffies, info->start_seek + IDECD_SEEK_TIMER)) {
 784                 if (--retry == 0)
 785                         drive->dsc_overlap = 0;
 786         }
 787         return ide_stopped;
 788 }
 789
 790 static ide_startstop_t cdrom_start_seek_continuation(ide_drive_t *drive)
 791 {
 792         struct request *rq = HWGROUP(drive)->rq;
 793         sector_t frame = rq->sector;
 794
 795         sector_div(frame, queue_hardsect_size(drive->queue) >> SECTOR_BITS);
 796
 797         memset(rq->cmd, 0, sizeof(rq->cmd));
 798         rq->cmd[0] = GPCMD_SEEK;
 799         put_unaligned(cpu_to_be32(frame), (unsigned int *) &rq->cmd[2]);
 800
 801         rq->timeout = ATAPI_WAIT_PC;
 802         return cdrom_transfer_packet_command(drive, rq, &cdrom_seek_intr);
 803 }
 804
 805 static ide_startstop_t cdrom_start_seek(ide_drive_t *drive, unsigned int block)
 806 {
 807         struct cdrom_info *info = drive->driver_data;
 808
 809         info->dma = 0;
 810         info->start_seek = jiffies;
 811         return cdrom_start_packet_command(drive, 0,
 812                                           cdrom_start_seek_continuation);
 813 }
 814
 815 /*
 816  * Fix up a possibly partially-processed request so that we can start it over
 817  * entirely, or even put it back on the request queue.
 818  */
 819 static void restore_request(struct request *rq)
 820 {
 821         if (rq->buffer != bio_data(rq->bio)) {
 822                 sector_t n =
 823                         (rq->buffer - (char *)bio_data(rq->bio)) / SECTOR_SIZE;
 824
 825                 rq->buffer = bio_data(rq->bio);
 826                 rq->nr_sectors += n;
 827                 rq->sector -= n;
 828         }
 829         rq->current_nr_sectors = bio_cur_sectors(rq->bio);
 830         rq->hard_cur_sectors = rq->current_nr_sectors;
 831         rq->hard_nr_sectors = rq->nr_sectors;
 832         rq->hard_sector = rq->sector;
 833         rq->q->prep_rq_fn(rq->q, rq);
 834 }
 835
 836 /*
 837  * All other packet commands.
 838  */
 839 static void ide_cd_request_sense_fixup(struct request *rq)
 840 {
 841         /*
 842          * Some of the trailing request sense fields are optional,
 843          * and some drives don't send them.  Sigh.
 844          */
 845         if (rq->cmd[0] == GPCMD_REQUEST_SENSE &&
 846             rq->data_len > 0 && rq->data_len <= 5)
 847                 while (rq->data_len > 0) {
 848                         *(u8 *)rq->data++ = 0;
 849                         --rq->data_len;
 850                 }
 851 }
 852
 853 int ide_cd_queue_pc(ide_drive_t *drive, struct request *rq)
 854 {
 855         struct request_sense sense;
 856         int retries = 10;
 857         unsigned int flags = rq->cmd_flags;
 858
 859         if (rq->sense == NULL)
 860                 rq->sense = &sense;
 861
 862         /* start of retry loop */
 863         do {
 864                 int error;
 865                 unsigned long time = jiffies;
 866                 rq->cmd_flags = flags;
 867
 868                 error = ide_do_drive_cmd(drive, rq, ide_wait);
 869                 time = jiffies - time;
 870
 871                 /*
 872                  * FIXME: we should probably abort/retry or something in case of
 873                  * failure.
 874                  */
 875                 if (rq->cmd_flags & REQ_FAILED) {
 876                         /*
 877                          * The request failed.  Retry if it was due to a unit
 878                          * attention status (usually means media was changed).
 879                          */
 880                         struct request_sense *reqbuf = rq->sense;
 881
 882                         if (reqbuf->sense_key == UNIT_ATTENTION)
 883                                 cdrom_saw_media_change(drive);
 884                         else if (reqbuf->sense_key == NOT_READY &&
 885                                  reqbuf->asc == 4 && reqbuf->ascq != 4) {
 886                                 /*
 887                                  * The drive is in the process of loading
 888                                  * a disk.  Retry, but wait a little to give
 889                                  * the drive time to complete the load.
 890                                  */
 891                                 ssleep(2);
 892                         } else {
 893                                 /* otherwise, don't retry */
 894                                 retries = 0;
 895                         }
 896                         --retries;
 897                 }
 898
 899                 /* end of retry loop */
 900         } while ((rq->cmd_flags & REQ_FAILED) && retries >= 0);
 901
 902         /* return an error if the command failed */
 903         return (rq->cmd_flags & REQ_FAILED) ? -EIO : 0;
 904 }
 905
 906 /*
 907  * Called from blk_end_request_callback() after the data of the request is
 908  * completed and before the request itself is completed. By returning value '1',
 909  * blk_end_request_callback() returns immediately without completing it.
 910  */
 911 static int cdrom_newpc_intr_dummy_cb(struct request *rq)
 912 {
 913         return 1;
 914 }
 915
 916 static ide_startstop_t cdrom_newpc_intr(ide_drive_t *drive)
 917 {
 918         ide_hwif_t *hwif = drive->hwif;
 919         struct cdrom_info *info = drive->driver_data;
 920         struct request *rq = HWGROUP(drive)->rq;
 921         xfer_func_t *xferfunc;
 922         ide_expiry_t *expiry = NULL;
 923         int dma_error = 0, dma, stat, ireason, len, thislen, uptodate = 0;
 924         int write = (rq_data_dir(rq) == WRITE) ? 1 : 0;
 925         unsigned int timeout;
 926         u8 lowcyl, highcyl;
 927
 928         /* check for errors */
 929         dma = info->dma;
 930         if (dma) {
 931                 info->dma = 0;
 932                 dma_error = hwif->dma_ops->dma_end(drive);
 933                 if (dma_error) {
 934                         printk(KERN_ERR "%s: DMA %s error\n", drive->name,
 935                                         write ? "write" : "read");
 936                         ide_dma_off(drive);
 937                 }
 938         }
 939
 940         if (cdrom_decode_status(drive, 0, &stat))
 941                 return ide_stopped;
 942
 943         /* using dma, transfer is complete now */
 944         if (dma) {
 945                 if (dma_error)
 946                         return ide_error(drive, "dma error", stat);
 947                 if (blk_fs_request(rq)) {
 948                         ide_end_request(drive, 1, rq->nr_sectors);
 949                         return ide_stopped;
 950                 }
 951                 goto end_request;
 952         }
 953
 954         /* ok we fall to pio :/ */
 955         ireason = hwif->INB(hwif->io_ports[IDE_IREASON_OFFSET]) & 0x3;
 956         lowcyl  = hwif->INB(hwif->io_ports[IDE_BCOUNTL_OFFSET]);
 957         highcyl = hwif->INB(hwif->io_ports[IDE_BCOUNTH_OFFSET]);
 958
 959         len = lowcyl + (256 * highcyl);
 960
 961         thislen = blk_fs_request(rq) ? len : rq->data_len;
 962         if (thislen > len)
 963                 thislen = len;
 964
 965         /* If DRQ is clear, the command has completed. */
 966         if ((stat & DRQ_STAT) == 0) {
 967                 if (blk_fs_request(rq)) {
 968                         /*
 969                          * If we're not done reading/writing, complain.
 970                          * Otherwise, complete the command normally.
 971                          */
 972                         uptodate = 1;
 973                         if (rq->current_nr_sectors > 0) {
 974                                 printk(KERN_ERR "%s: %s: data underrun "
 975                                                 "(%d blocks)\n",
 976                                                 drive->name, __func__,
 977                                                 rq->current_nr_sectors);
 978                                 if (!write)
 979                                         rq->cmd_flags |= REQ_FAILED;
 980                                 uptodate = 0;
 981                         }
 982                         cdrom_end_request(drive, uptodate);
 983                         return ide_stopped;
 984                 } else if (!blk_pc_request(rq)) {
 985                         ide_cd_request_sense_fixup(rq);
 986                         /* complain if we still have data left to transfer */
 987                         uptodate = rq->data_len ? 0 : 1;
 988                 }
 989                 goto end_request;
 990         }
 991
 992         /* check which way to transfer data */
 993         if (ide_cd_check_ireason(drive, rq, len, ireason, write))
 994                 return ide_stopped;
 995
 996         if (blk_fs_request(rq)) {
 997                 if (write == 0) {
 998                         int nskip;
 999
1000                         if (ide_cd_check_transfer_size(drive, len)) {
1001                                 cdrom_end_request(drive, 0);
1002                                 return ide_stopped;
1003                         }
1004
1005                         /*
1006                          * First, figure out if we need to bit-bucket
1007                          * any of the leading sectors.
1008                          */
1009                         nskip = min_t(int, rq->current_nr_sectors
1010                                            - bio_cur_sectors(rq->bio),
1011                                            thislen >> 9);
1012                         if (nskip > 0) {
1013                                 ide_cd_drain_data(drive, nskip);
1014                                 rq->current_nr_sectors -= nskip;
1015                                 thislen -= (nskip << 9);
1016                         }
1017                 }
1018         }
1019
1020         if (ireason == 0) {
1021                 write = 1;
1022                 xferfunc = HWIF(drive)->atapi_output_bytes;
1023         } else {
1024                 write = 0;
1025                 xferfunc = HWIF(drive)->atapi_input_bytes;
1026         }
1027
1028         /* transfer data */
1029         while (thislen > 0) {
1030                 u8 *ptr = blk_fs_request(rq) ? NULL : rq->data;
1031                 int blen = rq->data_len;
1032
1033                 /* bio backed? */
1034                 if (rq->bio) {
1035                         if (blk_fs_request(rq)) {
1036                                 ptr = rq->buffer;
1037                                 blen = rq->current_nr_sectors << 9;
1038                         } else {
1039                                 ptr = bio_data(rq->bio);
1040                                 blen = bio_iovec(rq->bio)->bv_len;
1041                         }
1042                 }
1043
1044                 if (!ptr) {
1045                         if (blk_fs_request(rq) && !write)
1046                                 /*
1047                                  * If the buffers are full, pipe the rest into
1048                                  * oblivion.
1049                                  */
1050                                 ide_cd_drain_data(drive, thislen >> 9);
1051                         else {
1052                                 printk(KERN_ERR "%s: confused, missing data\n",
1053                                                 drive->name);
1054                                 blk_dump_rq_flags(rq, rq_data_dir(rq)
1055                                                   ? "cdrom_newpc_intr, write"
1056                                                   : "cdrom_newpc_intr, read");
1057                         }
1058                         break;
1059                 }
1060
1061                 if (blen > thislen)
1062                         blen = thislen;
1063
1064                 xferfunc(drive, ptr, blen);
1065
1066                 thislen -= blen;
1067                 len -= blen;
1068
1069                 if (blk_fs_request(rq)) {
1070                         rq->buffer += blen;
1071                         rq->nr_sectors -= (blen >> 9);
1072                         rq->current_nr_sectors -= (blen >> 9);
1073                         rq->sector += (blen >> 9);
1074
1075                         if (rq->current_nr_sectors == 0 && rq->nr_sectors)
1076                                 cdrom_end_request(drive, 1);
1077                 } else {
1078                         rq->data_len -= blen;
1079
1080                         /*
1081                          * The request can't be completed until DRQ is cleared.
1082                          * So complete the data, but don't complete the request
1083                          * using the dummy function for the callback feature
1084                          * of blk_end_request_callback().
1085                          */
1086                         if (rq->bio)
1087                                 blk_end_request_callback(rq, 0, blen,
1088                                                  cdrom_newpc_intr_dummy_cb);
1089                         else
1090                                 rq->data += blen;
1091                 }
1092                 if (!write && blk_sense_request(rq))
1093                         rq->sense_len += blen;
1094         }
1095
1096         /* pad, if necessary */
1097         if (!blk_fs_request(rq) && len > 0)
1098                 ide_cd_pad_transfer(drive, xferfunc, len);
1099
1100         if (blk_pc_request(rq)) {
1101                 timeout = rq->timeout;
1102         } else {
1103                 timeout = ATAPI_WAIT_PC;
1104                 if (!blk_fs_request(rq))
1105                         expiry = cdrom_timer_expiry;
1106         }
1107
1108         ide_set_handler(drive, cdrom_newpc_intr, timeout, expiry);
1109         return ide_started;
1110
1111 end_request:
1112         if (blk_pc_request(rq)) {
1113                 unsigned long flags;
1114                 unsigned int dlen = rq->data_len;
1115
1116                 if (dma)
1117                         rq->data_len = 0;
1118
1119                 spin_lock_irqsave(&ide_lock, flags);
1120                 if (__blk_end_request(rq, 0, dlen))
1121                         BUG();
1122                 HWGROUP(drive)->rq = NULL;
1123                 spin_unlock_irqrestore(&ide_lock, flags);
1124         } else {
1125                 if (!uptodate)
1126                         rq->cmd_flags |= REQ_FAILED;
1127                 cdrom_end_request(drive, uptodate);
1128         }
1129         return ide_stopped;
1130 }
1131
1132 static ide_startstop_t cdrom_start_rw(ide_drive_t *drive, struct request *rq)
1133 {
1134         struct cdrom_info *cd = drive->driver_data;
1135         int write = rq_data_dir(rq) == WRITE;
1136         unsigned short sectors_per_frame =
1137                 queue_hardsect_size(drive->queue) >> SECTOR_BITS;
1138
1139         if (write) {
1140                 /* disk has become write protected */
1141                 if (cd->disk->policy) {
1142                         cdrom_end_request(drive, 0);
1143                         return ide_stopped;
1144                 }
1145         } else {
1146                 /*
1147                  * We may be retrying this request after an error.  Fix up any
1148                  * weirdness which might be present in the request packet.
1149                  */
1150                 restore_request(rq);
1151         }
1152
1153         /* use DMA, if possible / writes *must* be hardware frame aligned */
1154         if ((rq->nr_sectors & (sectors_per_frame - 1)) ||
1155             (rq->sector & (sectors_per_frame - 1))) {
1156                 if (write) {
1157                         cdrom_end_request(drive, 0);
1158                         return ide_stopped;
1159                 }
1160                 cd->dma = 0;
1161         } else
1162                 cd->dma = drive->using_dma;
1163
1164         if (write)
1165                 cd->devinfo.media_written = 1;
1166
1167         /* start sending the read/write request to the drive */
1168         return cdrom_start_packet_command(drive, 32768, cdrom_start_rw_cont);
1169 }
1170
1171 static ide_startstop_t cdrom_do_newpc_cont(ide_drive_t *drive)
1172 {
1173         struct request *rq = HWGROUP(drive)->rq;
1174
1175         if (!rq->timeout)
1176                 rq->timeout = ATAPI_WAIT_PC;
1177
1178         return cdrom_transfer_packet_command(drive, rq, cdrom_newpc_intr);
1179 }
1180
1181 static ide_startstop_t cdrom_do_block_pc(ide_drive_t *drive, struct request *rq)
1182 {
1183         struct cdrom_info *info = drive->driver_data;
1184
1185         if (blk_pc_request(rq))
1186                 rq->cmd_flags |= REQ_QUIET;
1187         else
1188                 rq->cmd_flags &= ~REQ_FAILED;
1189
1190         info->dma = 0;
1191
1192         /* sg request */
1193         if (rq->bio) {
1194                 int mask = drive->queue->dma_alignment;
1195                 unsigned long addr =
1196                         (unsigned long)page_address(bio_page(rq->bio));
1197
1198                 info->dma = drive->using_dma;
1199
1200                 /*
1201                  * check if dma is safe
1202                  *
1203                  * NOTE! The "len" and "addr" checks should possibly have
1204                  * separate masks.
1205                  */
1206                 if ((rq->data_len & 15) || (addr & mask))
1207                         info->dma = 0;
1208         }
1209
1210         /* start sending the command to the drive */
1211         return cdrom_start_packet_command(drive, rq->data_len,
1212                                           cdrom_do_newpc_cont);
1213 }
1214
1215 /*
1216  * cdrom driver request routine.
1217  */
1218 static ide_startstop_t ide_do_rw_cdrom(ide_drive_t *drive, struct request *rq,
1219                                         sector_t block)
1220 {
1221         ide_startstop_t action;
1222         struct cdrom_info *info = drive->driver_data;
1223
1224         if (blk_fs_request(rq)) {
1225                 if (info->cd_flags & IDE_CD_FLAG_SEEKING) {
1226                         unsigned long elapsed = jiffies - info->start_seek;
1227                         int stat = ide_read_status(drive);
1228
1229                         if ((stat & SEEK_STAT) != SEEK_STAT) {
1230                                 if (elapsed < IDECD_SEEK_TIMEOUT) {
1231                                         ide_stall_queue(drive,
1232                                                         IDECD_SEEK_TIMER);
1233                                         return ide_stopped;
1234                                 }
1235                                 printk(KERN_ERR "%s: DSC timeout\n",
1236                                                 drive->name);
1237                         }
1238                         info->cd_flags &= ~IDE_CD_FLAG_SEEKING;
1239                 }
1240                 if (rq_data_dir(rq) == READ &&
1241                     IDE_LARGE_SEEK(info->last_block, block,
1242                                    IDECD_SEEK_THRESHOLD) &&
1243                     drive->dsc_overlap)
1244                         action = cdrom_start_seek(drive, block);
1245                 else
1246                         action = cdrom_start_rw(drive, rq);
1247                 info->last_block = block;
1248                 return action;
1249         } else if (blk_sense_request(rq) || blk_pc_request(rq) ||
1250                    rq->cmd_type == REQ_TYPE_ATA_PC) {
1251                 return cdrom_do_block_pc(drive, rq);
1252         } else if (blk_special_request(rq)) {
1253                 /* right now this can only be a reset... */
1254                 cdrom_end_request(drive, 1);
1255                 return ide_stopped;
1256         }
1257
1258         blk_dump_rq_flags(rq, "ide-cd bad flags");
1259         cdrom_end_request(drive, 0);
1260         return ide_stopped;
1261 }
1262
1263
1264
1265 /*
1266  * Ioctl handling.
1267  *
1268  * Routines which queue packet commands take as a final argument a pointer to a
1269  * request_sense struct. If execution of the command results in an error with a
1270  * CHECK CONDITION status, this structure will be filled with the results of the
1271  * subsequent request sense command. The pointer can also be NULL, in which case
1272  * no sense information is returned.
1273  */
1274 static void msf_from_bcd(struct atapi_msf *msf)
1275 {
1276         msf->minute = BCD2BIN(msf->minute);
1277         msf->second = BCD2BIN(msf->second);
1278         msf->frame  = BCD2BIN(msf->frame);
1279 }
1280
1281 int cdrom_check_status(ide_drive_t *drive, struct request_sense *sense)
1282 {
1283         struct request req;
1284         struct cdrom_info *info = drive->driver_data;
1285         struct cdrom_device_info *cdi = &info->devinfo;
1286
1287         ide_cd_init_rq(drive, &req);
1288
1289         req.sense = sense;
1290         req.cmd[0] = GPCMD_TEST_UNIT_READY;
1291         req.cmd_flags |= REQ_QUIET;
1292
1293         /*
1294          * Sanyo 3 CD changer uses byte 7 of TEST_UNIT_READY to switch CDs
1295          * instead of supporting the LOAD_UNLOAD opcode.
1296          */
1297         req.cmd[7] = cdi->sanyo_slot % 3;
1298
1299         return ide_cd_queue_pc(drive, &req);
1300 }
1301
1302 static int cdrom_read_capacity(ide_drive_t *drive, unsigned long *capacity,
1303                                unsigned long *sectors_per_frame,
1304                                struct request_sense *sense)
1305 {
1306         struct {
1307                 __u32 lba;
1308                 __u32 blocklen;
1309         } capbuf;
1310
1311         int stat;
1312         struct request req;
1313
1314         ide_cd_init_rq(drive, &req);
1315
1316         req.sense = sense;
1317         req.cmd[0] = GPCMD_READ_CDVD_CAPACITY;
1318         req.data = (char *)&capbuf;
1319         req.data_len = sizeof(capbuf);
1320         req.cmd_flags |= REQ_QUIET;
1321
1322         stat = ide_cd_queue_pc(drive, &req);
1323         if (stat == 0) {
1324                 *capacity = 1 + be32_to_cpu(capbuf.lba);
1325                 *sectors_per_frame =
1326                         be32_to_cpu(capbuf.blocklen) >> SECTOR_BITS;
1327         }
1328
1329         return stat;
1330 }
1331
1332 static int cdrom_read_tocentry(ide_drive_t *drive, int trackno, int msf_flag,
1333                                 int format, char *buf, int buflen,
1334                                 struct request_sense *sense)
1335 {
1336         struct request req;
1337
1338         ide_cd_init_rq(drive, &req);
1339
1340         req.sense = sense;
1341         req.data =  buf;
1342         req.data_len = buflen;
1343         req.cmd_flags |= REQ_QUIET;
1344         req.cmd[0] = GPCMD_READ_TOC_PMA_ATIP;
1345         req.cmd[6] = trackno;
1346         req.cmd[7] = (buflen >> 8);
1347         req.cmd[8] = (buflen & 0xff);
1348         req.cmd[9] = (format << 6);
1349
1350         if (msf_flag)
1351                 req.cmd[1] = 2;
1352
1353         return ide_cd_queue_pc(drive, &req);
1354 }
1355
1356 /* Try to read the entire TOC for the disk into our internal buffer. */
1357 int ide_cd_read_toc(ide_drive_t *drive, struct request_sense *sense)
1358 {
1359         int stat, ntracks, i;
1360         struct cdrom_info *info = drive->driver_data;
1361         struct cdrom_device_info *cdi = &info->devinfo;
1362         struct atapi_toc *toc = info->toc;
1363         struct {
1364                 struct atapi_toc_header hdr;
1365                 struct atapi_toc_entry  ent;
1366         } ms_tmp;
1367         long last_written;
1368         unsigned long sectors_per_frame = SECTORS_PER_FRAME;
1369
1370         if (toc == NULL) {
1371                 /* try to allocate space */
1372                 toc = kmalloc(sizeof(struct atapi_toc), GFP_KERNEL);
1373                 if (toc == NULL) {
1374                         printk(KERN_ERR "%s: No cdrom TOC buffer!\n",
1375                                         drive->name);
1376                         return -ENOMEM;
1377                 }
1378                 info->toc = toc;
1379         }
1380
1381         /*
1382          * Check to see if the existing data is still valid. If it is,
1383          * just return.
1384          */
1385         (void) cdrom_check_status(drive, sense);
1386
1387         if (info->cd_flags & IDE_CD_FLAG_TOC_VALID)
1388                 return 0;
1389
1390         /* try to get the total cdrom capacity and sector size */
1391         stat = cdrom_read_capacity(drive, &toc->capacity, &sectors_per_frame,
1392                                    sense);
1393         if (stat)
1394                 toc->capacity = 0x1fffff;
1395
1396         set_capacity(info->disk, toc->capacity * sectors_per_frame);
1397         /* save a private copy of the TOC capacity for error handling */
1398         drive->probed_capacity = toc->capacity * sectors_per_frame;
1399
1400         blk_queue_hardsect_size(drive->queue,
1401                                 sectors_per_frame << SECTOR_BITS);
1402
1403         /* first read just the header, so we know how long the TOC is */
1404         stat = cdrom_read_tocentry(drive, 0, 1, 0, (char *) &toc->hdr,
1405                                     sizeof(struct atapi_toc_header), sense);
1406         if (stat)
1407                 return stat;
1408
1409         if (info->cd_flags & IDE_CD_FLAG_TOCTRACKS_AS_BCD) {
1410                 toc->hdr.first_track = BCD2BIN(toc->hdr.first_track);
1411                 toc->hdr.last_track  = BCD2BIN(toc->hdr.last_track);
1412         }
1413
1414         ntracks = toc->hdr.last_track - toc->hdr.first_track + 1;
1415         if (ntracks <= 0)
1416                 return -EIO;
1417         if (ntracks > MAX_TRACKS)
1418                 ntracks = MAX_TRACKS;
1419
1420         /* now read the whole schmeer */
1421         stat = cdrom_read_tocentry(drive, toc->hdr.first_track, 1, 0,
1422                                   (char *)&toc->hdr,
1423                                    sizeof(struct atapi_toc_header) +
1424                                    (ntracks + 1) *
1425                                    sizeof(struct atapi_toc_entry), sense);
1426
1427         if (stat && toc->hdr.first_track > 1) {
1428                 /*
1429                  * Cds with CDI tracks only don't have any TOC entries, despite
1430                  * of this the returned values are
1431                  * first_track == last_track = number of CDI tracks + 1,
1432                  * so that this case is indistinguishable from the same layout
1433                  * plus an additional audio track. If we get an error for the
1434                  * regular case, we assume a CDI without additional audio
1435                  * tracks. In this case the readable TOC is empty (CDI tracks
1436                  * are not included) and only holds the Leadout entry.
1437                  *
1438                  * Heiko Eißfeldt.
1439                  */
1440                 ntracks = 0;
1441                 stat = cdrom_read_tocentry(drive, CDROM_LEADOUT, 1, 0,
1442                                            (char *)&toc->hdr,
1443                                            sizeof(struct atapi_toc_header) +
1444                                            (ntracks + 1) *
1445                                            sizeof(struct atapi_toc_entry),
1446                                            sense);
1447                 if (stat)
1448                         return stat;
1449
1450                 if (info->cd_flags & IDE_CD_FLAG_TOCTRACKS_AS_BCD) {
1451                         toc->hdr.first_track = (u8)BIN2BCD(CDROM_LEADOUT);
1452                         toc->hdr.last_track = (u8)BIN2BCD(CDROM_LEADOUT);
1453                 } else {
1454                         toc->hdr.first_track = CDROM_LEADOUT;
1455                         toc->hdr.last_track = CDROM_LEADOUT;
1456                 }
1457         }
1458
1459         if (stat)
1460                 return stat;
1461
1462         toc->hdr.toc_length = be16_to_cpu(toc->hdr.toc_length);
1463
1464         if (info->cd_flags & IDE_CD_FLAG_TOCTRACKS_AS_BCD) {
1465                 toc->hdr.first_track = BCD2BIN(toc->hdr.first_track);
1466                 toc->hdr.last_track  = BCD2BIN(toc->hdr.last_track);
1467         }
1468
1469         for (i = 0; i <= ntracks; i++) {
1470                 if (info->cd_flags & IDE_CD_FLAG_TOCADDR_AS_BCD) {
1471                         if (info->cd_flags & IDE_CD_FLAG_TOCTRACKS_AS_BCD)
1472                                 toc->ent[i].track = BCD2BIN(toc->ent[i].track);
1473                         msf_from_bcd(&toc->ent[i].addr.msf);
1474                 }
1475                 toc->ent[i].addr.lba = msf_to_lba(toc->ent[i].addr.msf.minute,
1476                                                   toc->ent[i].addr.msf.second,
1477                                                   toc->ent[i].addr.msf.frame);
1478         }
1479
1480         if (toc->hdr.first_track != CDROM_LEADOUT) {
1481                 /* read the multisession information */
1482                 stat = cdrom_read_tocentry(drive, 0, 0, 1, (char *)&ms_tmp,
1483                                            sizeof(ms_tmp), sense);
1484                 if (stat)
1485                         return stat;
1486
1487                 toc->last_session_lba = be32_to_cpu(ms_tmp.ent.addr.lba);
1488         } else {
1489                 ms_tmp.hdr.last_track = CDROM_LEADOUT;
1490                 ms_tmp.hdr.first_track = ms_tmp.hdr.last_track;
1491                 toc->last_session_lba = msf_to_lba(0, 2, 0); /* 0m 2s 0f */
1492         }
1493
1494         if (info->cd_flags & IDE_CD_FLAG_TOCADDR_AS_BCD) {
1495                 /* re-read multisession information using MSF format */
1496                 stat = cdrom_read_tocentry(drive, 0, 1, 1, (char *)&ms_tmp,
1497                                            sizeof(ms_tmp), sense);
1498                 if (stat)
1499                         return stat;
1500
1501                 msf_from_bcd(&ms_tmp.ent.addr.msf);
1502                 toc->last_session_lba = msf_to_lba(ms_tmp.ent.addr.msf.minute,
1503                                                    ms_tmp.ent.addr.msf.second,
1504                                                    ms_tmp.ent.addr.msf.frame);
1505         }
1506
1507         toc->xa_flag = (ms_tmp.hdr.first_track != ms_tmp.hdr.last_track);
1508
1509         /* now try to get the total cdrom capacity */
1510         stat = cdrom_get_last_written(cdi, &last_written);
1511         if (!stat && (last_written > toc->capacity)) {
1512                 toc->capacity = last_written;
1513                 set_capacity(info->disk, toc->capacity * sectors_per_frame);
1514                 drive->probed_capacity = toc->capacity * sectors_per_frame;
1515         }
1516
1517         /* Remember that we've read this stuff. */
1518         info->cd_flags |= IDE_CD_FLAG_TOC_VALID;
1519
1520         return 0;
1521 }
1522
1523 int ide_cdrom_get_capabilities(ide_drive_t *drive, u8 *buf)
1524 {
1525         struct cdrom_info *info = drive->driver_data;
1526         struct cdrom_device_info *cdi = &info->devinfo;
1527         struct packet_command cgc;
1528         int stat, attempts = 3, size = ATAPI_CAPABILITIES_PAGE_SIZE;
1529
1530         if ((info->cd_flags & IDE_CD_FLAG_FULL_CAPS_PAGE) == 0)
1531                 size -= ATAPI_CAPABILITIES_PAGE_PAD_SIZE;
1532
1533         init_cdrom_command(&cgc, buf, size, CGC_DATA_UNKNOWN);
1534         do {
1535                 /* we seem to get stat=0x01,err=0x00 the first time (??) */
1536                 stat = cdrom_mode_sense(cdi, &cgc, GPMODE_CAPABILITIES_PAGE, 0);
1537                 if (!stat)
1538                         break;
1539         } while (--attempts);
1540         return stat;
1541 }
1542
1543 void ide_cdrom_update_speed(ide_drive_t *drive, u8 *buf)
1544 {
1545         struct cdrom_info *cd = drive->driver_data;
1546         u16 curspeed, maxspeed;
1547
1548         curspeed = *(u16 *)&buf[8 + 14];
1549         maxspeed = *(u16 *)&buf[8 +  8];
1550
1551         if (cd->cd_flags & IDE_CD_FLAG_LE_SPEED_FIELDS) {
1552                 curspeed = le16_to_cpu(curspeed);
1553                 maxspeed = le16_to_cpu(maxspeed);
1554         } else {
1555                 curspeed = be16_to_cpu(curspeed);
1556                 maxspeed = be16_to_cpu(maxspeed);
1557         }
1558
1559         cd->current_speed = (curspeed + (176/2)) / 176;
1560         cd->max_speed = (maxspeed + (176/2)) / 176;
1561 }
1562
1563 #define IDE_CD_CAPABILITIES \
1564         (CDC_CLOSE_TRAY | CDC_OPEN_TRAY | CDC_LOCK | CDC_SELECT_SPEED | \
1565          CDC_SELECT_DISC | CDC_MULTI_SESSION | CDC_MCN | CDC_MEDIA_CHANGED | \
1566          CDC_PLAY_AUDIO | CDC_RESET | CDC_DRIVE_STATUS | CDC_CD_R | \
1567          CDC_CD_RW | CDC_DVD | CDC_DVD_R | CDC_DVD_RAM | CDC_GENERIC_PACKET | \
1568          CDC_MO_DRIVE | CDC_MRW | CDC_MRW_W | CDC_RAM)
1569
1570 static struct cdrom_device_ops ide_cdrom_dops = {
1571         .open                   = ide_cdrom_open_real,
1572         .release                = ide_cdrom_release_real,
1573         .drive_status           = ide_cdrom_drive_status,
1574         .media_changed          = ide_cdrom_check_media_change_real,
1575         .tray_move              = ide_cdrom_tray_move,
1576         .lock_door              = ide_cdrom_lock_door,
1577         .select_speed           = ide_cdrom_select_speed,
1578         .get_last_session       = ide_cdrom_get_last_session,
1579         .get_mcn                = ide_cdrom_get_mcn,
1580         .reset                  = ide_cdrom_reset,
1581         .audio_ioctl            = ide_cdrom_audio_ioctl,
1582         .capability             = IDE_CD_CAPABILITIES,
1583         .generic_packet         = ide_cdrom_packet,
1584 };
1585
1586 static int ide_cdrom_register(ide_drive_t *drive, int nslots)
1587 {
1588         struct cdrom_info *info = drive->driver_data;
1589         struct cdrom_device_info *devinfo = &info->devinfo;
1590
1591         devinfo->ops = &ide_cdrom_dops;
1592         devinfo->speed = info->current_speed;
1593         devinfo->capacity = nslots;
1594         devinfo->handle = drive;
1595         strcpy(devinfo->name, drive->name);
1596
1597         if (info->cd_flags & IDE_CD_FLAG_NO_SPEED_SELECT)
1598                 devinfo->mask |= CDC_SELECT_SPEED;
1599
1600         devinfo->disk = info->disk;
1601         return register_cdrom(devinfo);
1602 }
1603
1604 static int ide_cdrom_probe_capabilities(ide_drive_t *drive)
1605 {
1606         struct cdrom_info *cd = drive->driver_data;
1607         struct cdrom_device_info *cdi = &cd->devinfo;
1608         u8 buf[ATAPI_CAPABILITIES_PAGE_SIZE];
1609         mechtype_t mechtype;
1610         int nslots = 1;
1611
1612         cdi->mask = (CDC_CD_R | CDC_CD_RW | CDC_DVD | CDC_DVD_R |
1613                      CDC_DVD_RAM | CDC_SELECT_DISC | CDC_PLAY_AUDIO |
1614                      CDC_MO_DRIVE | CDC_RAM);
1615
1616         if (drive->media == ide_optical) {
1617                 cdi->mask &= ~(CDC_MO_DRIVE | CDC_RAM);
1618                 printk(KERN_ERR "%s: ATAPI magneto-optical drive\n",
1619                                 drive->name);
1620                 return nslots;
1621         }
1622
1623         if (cd->cd_flags & IDE_CD_FLAG_PRE_ATAPI12) {
1624                 cd->cd_flags &= ~IDE_CD_FLAG_NO_EJECT;
1625                 cdi->mask &= ~CDC_PLAY_AUDIO;
1626                 return nslots;
1627         }
1628
1629         /*
1630          * We have to cheat a little here. the packet will eventually be queued
1631          * with ide_cdrom_packet(), which extracts the drive from cdi->handle.
1632          * Since this device hasn't been registered with the Uniform layer yet,
1633          * it can't do this. Same goes for cdi->ops.
1634          */
1635         cdi->handle = drive;
1636         cdi->ops = &ide_cdrom_dops;
1637
1638         if (ide_cdrom_get_capabilities(drive, buf))
1639                 return 0;
1640
1641         if ((buf[8 + 6] & 0x01) == 0)
1642                 cd->cd_flags |= IDE_CD_FLAG_NO_DOORLOCK;
1643         if (buf[8 + 6] & 0x08)
1644                 cd->cd_flags &= ~IDE_CD_FLAG_NO_EJECT;
1645         if (buf[8 + 3] & 0x01)
1646                 cdi->mask &= ~CDC_CD_R;
1647         if (buf[8 + 3] & 0x02)
1648                 cdi->mask &= ~(CDC_CD_RW | CDC_RAM);
1649         if (buf[8 + 2] & 0x38)
1650                 cdi->mask &= ~CDC_DVD;
1651         if (buf[8 + 3] & 0x20)
1652                 cdi->mask &= ~(CDC_DVD_RAM | CDC_RAM);
1653         if (buf[8 + 3] & 0x10)
1654                 cdi->mask &= ~CDC_DVD_R;
1655         if ((buf[8 + 4] & 0x01) || (cd->cd_flags & IDE_CD_FLAG_PLAY_AUDIO_OK))
1656                 cdi->mask &= ~CDC_PLAY_AUDIO;
1657
1658         mechtype = buf[8 + 6] >> 5;
1659         if (mechtype == mechtype_caddy || mechtype == mechtype_popup)
1660                 cdi->mask |= CDC_CLOSE_TRAY;
1661
1662         if (cdi->sanyo_slot > 0) {
1663                 cdi->mask &= ~CDC_SELECT_DISC;
1664                 nslots = 3;
1665         } else if (mechtype == mechtype_individual_changer ||
1666                    mechtype == mechtype_cartridge_changer) {
1667                 nslots = cdrom_number_of_slots(cdi);
1668                 if (nslots > 1)
1669                         cdi->mask &= ~CDC_SELECT_DISC;
1670         }
1671
1672         ide_cdrom_update_speed(drive, buf);
1673
1674         printk(KERN_INFO "%s: ATAPI", drive->name);
1675
1676         /* don't print speed if the drive reported 0 */
1677         if (cd->max_speed)
1678                 printk(KERN_CONT " %dX", cd->max_speed);
1679
1680         printk(KERN_CONT " %s", (cdi->mask & CDC_DVD) ? "CD-ROM" : "DVD-ROM");
1681
1682         if ((cdi->mask & CDC_DVD_R) == 0 || (cdi->mask & CDC_DVD_RAM) == 0)
1683                 printk(KERN_CONT " DVD%s%s",
1684                                  (cdi->mask & CDC_DVD_R) ? "" : "-R",
1685                                  (cdi->mask & CDC_DVD_RAM) ? "" : "-RAM");
1686
1687         if ((cdi->mask & CDC_CD_R) == 0 || (cdi->mask & CDC_CD_RW) == 0)
1688                 printk(KERN_CONT " CD%s%s",
1689                                  (cdi->mask & CDC_CD_R) ? "" : "-R",
1690                                  (cdi->mask & CDC_CD_RW) ? "" : "/RW");
1691
1692         if ((cdi->mask & CDC_SELECT_DISC) == 0)
1693                 printk(KERN_CONT " changer w/%d slots", nslots);
1694         else
1695                 printk(KERN_CONT " drive");
1696
1697         printk(KERN_CONT ", %dkB Cache\n", be16_to_cpu(*(u16 *)&buf[8 + 12]));
1698
1699         return nslots;
1700 }
1701
1702 /* standard prep_rq_fn that builds 10 byte cmds */
1703 static int ide_cdrom_prep_fs(struct request_queue *q, struct request *rq)
1704 {
1705         int hard_sect = queue_hardsect_size(q);
1706         long block = (long)rq->hard_sector / (hard_sect >> 9);
1707         unsigned long blocks = rq->hard_nr_sectors / (hard_sect >> 9);
1708
1709         memset(rq->cmd, 0, sizeof(rq->cmd));
1710
1711         if (rq_data_dir(rq) == READ)
1712                 rq->cmd[0] = GPCMD_READ_10;
1713         else
1714                 rq->cmd[0] = GPCMD_WRITE_10;
1715
1716         /*
1717          * fill in lba
1718          */
1719         rq->cmd[2] = (block >> 24) & 0xff;
1720         rq->cmd[3] = (block >> 16) & 0xff;
1721         rq->cmd[4] = (block >>  8) & 0xff;
1722         rq->cmd[5] = block & 0xff;
1723
1724         /*
1725          * and transfer length
1726          */
1727         rq->cmd[7] = (blocks >> 8) & 0xff;
1728         rq->cmd[8] = blocks & 0xff;
1729         rq->cmd_len = 10;
1730         return BLKPREP_OK;
1731 }
1732
1733 /*
1734  * Most of the SCSI commands are supported directly by ATAPI devices.
1735  * This transform handles the few exceptions.
1736  */
1737 static int ide_cdrom_prep_pc(struct request *rq)
1738 {
1739         u8 *c = rq->cmd;
1740
1741         /* transform 6-byte read/write commands to the 10-byte version */
1742         if (c[0] == READ_6 || c[0] == WRITE_6) {
1743                 c[8] = c[4];
1744                 c[5] = c[3];
1745                 c[4] = c[2];
1746                 c[3] = c[1] & 0x1f;
1747                 c[2] = 0;
1748                 c[1] &= 0xe0;
1749                 c[0] += (READ_10 - READ_6);
1750                 rq->cmd_len = 10;
1751                 return BLKPREP_OK;
1752         }
1753
1754         /*
1755          * it's silly to pretend we understand 6-byte sense commands, just
1756          * reject with ILLEGAL_REQUEST and the caller should take the
1757          * appropriate action
1758          */
1759         if (c[0] == MODE_SENSE || c[0] == MODE_SELECT) {
1760                 rq->errors = ILLEGAL_REQUEST;
1761                 return BLKPREP_KILL;
1762         }
1763
1764         return BLKPREP_OK;
1765 }
1766
1767 static int ide_cdrom_prep_fn(struct request_queue *q, struct request *rq)
1768 {
1769         if (blk_fs_request(rq))
1770                 return ide_cdrom_prep_fs(q, rq);
1771         else if (blk_pc_request(rq))
1772                 return ide_cdrom_prep_pc(rq);
1773
1774         return 0;
1775 }
1776
1777 struct cd_list_entry {
1778         const char      *id_model;
1779         const char      *id_firmware;
1780         unsigned int    cd_flags;
1781 };
1782
1783 #ifdef CONFIG_IDE_PROC_FS
1784 static sector_t ide_cdrom_capacity(ide_drive_t *drive)
1785 {
1786         unsigned long capacity, sectors_per_frame;
1787
1788         if (cdrom_read_capacity(drive, &capacity, &sectors_per_frame, NULL))
1789                 return 0;
1790
1791         return capacity * sectors_per_frame;
1792 }
1793
1794 static int proc_idecd_read_capacity(char *page, char **start, off_t off,
1795                                         int count, int *eof, void *data)
1796 {
1797         ide_drive_t *drive = data;
1798         int len;
1799
1800         len = sprintf(page, "%llu\n", (long long)ide_cdrom_capacity(drive));
1801         PROC_IDE_READ_RETURN(page, start, off, count, eof, len);
1802 }
1803
1804 static ide_proc_entry_t idecd_proc[] = {
1805         { "capacity", S_IFREG|S_IRUGO, proc_idecd_read_capacity, NULL },
1806         { NULL, 0, NULL, NULL }
1807 };
1808
1809 static void ide_cdrom_add_settings(ide_drive_t *drive)
1810 {
1811         ide_add_setting(drive, "dsc_overlap", SETTING_RW, TYPE_BYTE, 0, 1, 1, 1,
1812                         &drive->dsc_overlap, NULL);
1813 }
1814 #else
1815 static inline void ide_cdrom_add_settings(ide_drive_t *drive) { ; }
1816 #endif
1817
1818 static const struct cd_list_entry ide_cd_quirks_list[] = {
1819         /* Limit transfer size per interrupt. */
1820         { "SAMSUNG CD-ROM SCR-2430", NULL,   IDE_CD_FLAG_LIMIT_NFRAMES      },
1821         { "SAMSUNG CD-ROM SCR-2432", NULL,   IDE_CD_FLAG_LIMIT_NFRAMES      },
1822         /* SCR-3231 doesn't support the SET_CD_SPEED command. */
1823         { "SAMSUNG CD-ROM SCR-3231", NULL,   IDE_CD_FLAG_NO_SPEED_SELECT    },
1824         /* Old NEC260 (not R) was released before ATAPI 1.2 spec. */
1825         { "NEC CD-ROM DRIVE:260",    "1.01", IDE_CD_FLAG_TOCADDR_AS_BCD |
1826                                              IDE_CD_FLAG_PRE_ATAPI12,       },
1827         /* Vertos 300, some versions of this drive like to talk BCD. */
1828         { "V003S0DS",                NULL,   IDE_CD_FLAG_VERTOS_300_SSD,    },
1829         /* Vertos 600 ESD. */
1830         { "V006E0DS",                NULL,   IDE_CD_FLAG_VERTOS_600_ESD,    },
1831         /*
1832          * Sanyo 3 CD changer uses a non-standard command for CD changing
1833          * (by default standard ATAPI support for CD changers is used).
1834          */
1835         { "CD-ROM CDR-C3 G",         NULL,   IDE_CD_FLAG_SANYO_3CD          },
1836         { "CD-ROM CDR-C3G",          NULL,   IDE_CD_FLAG_SANYO_3CD          },
1837         { "CD-ROM CDR_C36",          NULL,   IDE_CD_FLAG_SANYO_3CD          },
1838         /* Stingray 8X CD-ROM. */
1839         { "STINGRAY 8422 IDE 8X CD-ROM 7-27-95", NULL, IDE_CD_FLAG_PRE_ATAPI12},
1840         /*
1841          * ACER 50X CD-ROM and WPI 32X CD-ROM require the full spec length
1842          * mode sense page capabilities size, but older drives break.
1843          */
1844         { "ATAPI CD ROM DRIVE 50X MAX", NULL,   IDE_CD_FLAG_FULL_CAPS_PAGE  },
1845         { "WPI CDS-32X",                NULL,   IDE_CD_FLAG_FULL_CAPS_PAGE  },
1846         /* ACER/AOpen 24X CD-ROM has the speed fields byte-swapped. */
1847         { "",                        "241N", IDE_CD_FLAG_LE_SPEED_FIELDS    },
1848         /*
1849          * Some drives used by Apple don't advertise audio play
1850          * but they do support reading TOC & audio datas.
1851          */
1852         { "MATSHITADVD-ROM SR-8187", NULL,   IDE_CD_FLAG_PLAY_AUDIO_OK      },
1853         { "MATSHITADVD-ROM SR-8186", NULL,   IDE_CD_FLAG_PLAY_AUDIO_OK      },
1854         { "MATSHITADVD-ROM SR-8176", NULL,   IDE_CD_FLAG_PLAY_AUDIO_OK      },
1855         { "MATSHITADVD-ROM SR-8174", NULL,   IDE_CD_FLAG_PLAY_AUDIO_OK      },
1856         { "Optiarc DVD RW AD-5200A", NULL,   IDE_CD_FLAG_PLAY_AUDIO_OK      },
1857         { NULL, NULL, 0 }
1858 };
1859
1860 static unsigned int ide_cd_flags(struct hd_driveid *id)
1861 {
1862         const struct cd_list_entry *cle = ide_cd_quirks_list;
1863
1864         while (cle->id_model) {
1865                 if (strcmp(cle->id_model, id->model) == 0 &&
1866                     (cle->id_firmware == NULL ||
1867                      strstr(id->fw_rev, cle->id_firmware)))
1868                         return cle->cd_flags;
1869                 cle++;
1870         }
1871
1872         return 0;
1873 }
1874
1875 static int ide_cdrom_setup(ide_drive_t *drive)
1876 {
1877         struct cdrom_info *cd = drive->driver_data;
1878         struct cdrom_device_info *cdi = &cd->devinfo;
1879         struct hd_driveid *id = drive->id;
1880         int nslots;
1881
1882         blk_queue_prep_rq(drive->queue, ide_cdrom_prep_fn);
1883         blk_queue_dma_alignment(drive->queue, 31);
1884         drive->queue->unplug_delay = (1 * HZ) / 1000;
1885         if (!drive->queue->unplug_delay)
1886                 drive->queue->unplug_delay = 1;
1887
1888         drive->special.all      = 0;
1889
1890         cd->cd_flags = IDE_CD_FLAG_MEDIA_CHANGED | IDE_CD_FLAG_NO_EJECT |
1891                        ide_cd_flags(id);
1892
1893         if ((id->config & 0x0060) == 0x20)
1894                 cd->cd_flags |= IDE_CD_FLAG_DRQ_INTERRUPT;
1895
1896         if ((cd->cd_flags & IDE_CD_FLAG_VERTOS_300_SSD) &&
1897             id->fw_rev[4] == '1' && id->fw_rev[6] <= '2')
1898                 cd->cd_flags |= (IDE_CD_FLAG_TOCTRACKS_AS_BCD |
1899                                  IDE_CD_FLAG_TOCADDR_AS_BCD);
1900         else if ((cd->cd_flags & IDE_CD_FLAG_VERTOS_600_ESD) &&
1901                  id->fw_rev[4] == '1' && id->fw_rev[6] <= '2')
1902                 cd->cd_flags |= IDE_CD_FLAG_TOCTRACKS_AS_BCD;
1903         else if (cd->cd_flags & IDE_CD_FLAG_SANYO_3CD)
1904                 /* 3 => use CD in slot 0 */
1905                 cdi->sanyo_slot = 3;
1906
1907         nslots = ide_cdrom_probe_capabilities(drive);
1908
1909         /* set correct block size */
1910         blk_queue_hardsect_size(drive->queue, CD_FRAMESIZE);
1911
1912         if (drive->autotune == IDE_TUNE_DEFAULT ||
1913             drive->autotune == IDE_TUNE_AUTO)
1914                 drive->dsc_overlap = (drive->next != drive);
1915
1916         if (ide_cdrom_register(drive, nslots)) {
1917                 printk(KERN_ERR "%s: %s failed to register device with the"
1918                                 " cdrom driver.\n", drive->name, __func__);
1919                 cd->devinfo.handle = NULL;
1920                 return 1;
1921         }
1922         ide_cdrom_add_settings(drive);
1923         return 0;
1924 }
1925
1926 static void ide_cd_remove(ide_drive_t *drive)
1927 {
1928         struct cdrom_info *info = drive->driver_data;
1929
1930         ide_proc_unregister_driver(drive, info->driver);
1931
1932         del_gendisk(info->disk);
1933
1934         ide_cd_put(info);
1935 }
1936
1937 static void ide_cd_release(struct kref *kref)
1938 {
1939         struct cdrom_info *info = to_ide_cd(kref);
1940         struct cdrom_device_info *devinfo = &info->devinfo;
1941         ide_drive_t *drive = info->drive;
1942         struct gendisk *g = info->disk;
1943
1944         kfree(info->toc);
1945         if (devinfo->handle == drive)
1946                 unregister_cdrom(devinfo);
1947         drive->dsc_overlap = 0;
1948         drive->driver_data = NULL;
1949         blk_queue_prep_rq(drive->queue, NULL);
1950         g->private_data = NULL;
1951         put_disk(g);
1952         kfree(info);
1953 }
1954
1955 static int ide_cd_probe(ide_drive_t *);
1956
1957 static ide_driver_t ide_cdrom_driver = {
1958         .gen_driver = {
1959                 .owner          = THIS_MODULE,
1960                 .name           = "ide-cdrom",
1961                 .bus            = &ide_bus_type,
1962         },
1963         .probe                  = ide_cd_probe,
1964         .remove                 = ide_cd_remove,
1965         .version                = IDECD_VERSION,
1966         .media                  = ide_cdrom,
1967         .supports_dsc_overlap   = 1,
1968         .do_request             = ide_do_rw_cdrom,
1969         .end_request            = ide_end_request,
1970         .error                  = __ide_error,
1971         .abort                  = __ide_abort,
1972 #ifdef CONFIG_IDE_PROC_FS
1973         .proc                   = idecd_proc,
1974 #endif
1975 };
1976
1977 static int idecd_open(struct inode *inode, struct file *file)
1978 {
1979         struct gendisk *disk = inode->i_bdev->bd_disk;
1980         struct cdrom_info *info;
1981         int rc = -ENOMEM;
1982
1983         info = ide_cd_get(disk);
1984         if (!info)
1985                 return -ENXIO;
1986
1987         rc = cdrom_open(&info->devinfo, inode, file);
1988
1989         if (rc < 0)
1990                 ide_cd_put(info);
1991
1992         return rc;
1993 }
1994
1995 static int idecd_release(struct inode *inode, struct file *file)
1996 {
1997         struct gendisk *disk = inode->i_bdev->bd_disk;
1998         struct cdrom_info *info = ide_cd_g(disk);
1999
2000         cdrom_release(&info->devinfo, file);
2001
2002         ide_cd_put(info);
2003
2004         return 0;
2005 }
2006
2007 static int idecd_set_spindown(struct cdrom_device_info *cdi, unsigned long arg)
2008 {
2009         struct packet_command cgc;
2010         char buffer[16];
2011         int stat;
2012         char spindown;
2013
2014         if (copy_from_user(&spindown, (void __user *)arg, sizeof(char)))
2015                 return -EFAULT;
2016
2017         init_cdrom_command(&cgc, buffer, sizeof(buffer), CGC_DATA_UNKNOWN);
2018
2019         stat = cdrom_mode_sense(cdi, &cgc, GPMODE_CDROM_PAGE, 0);
2020         if (stat)
2021                 return stat;
2022
2023         buffer[11] = (buffer[11] & 0xf0) | (spindown & 0x0f);
2024         return cdrom_mode_select(cdi, &cgc);
2025 }
2026
2027 static int idecd_get_spindown(struct cdrom_device_info *cdi, unsigned long arg)
2028 {
2029         struct packet_command cgc;
2030         char buffer[16];
2031         int stat;
2032         char spindown;
2033
2034         init_cdrom_command(&cgc, buffer, sizeof(buffer), CGC_DATA_UNKNOWN);
2035
2036         stat = cdrom_mode_sense(cdi, &cgc, GPMODE_CDROM_PAGE, 0);
2037         if (stat)
2038                 return stat;
2039
2040         spindown = buffer[11] & 0x0f;
2041         if (copy_to_user((void __user *)arg, &spindown, sizeof(char)))
2042                 return -EFAULT;
2043         return 0;
2044 }
2045
2046 static int idecd_ioctl(struct inode *inode, struct file *file,
2047                         unsigned int cmd, unsigned long arg)
2048 {
2049         struct block_device *bdev = inode->i_bdev;
2050         struct cdrom_info *info = ide_cd_g(bdev->bd_disk);
2051         int err;
2052
2053         switch (cmd) {
2054         case CDROMSETSPINDOWN:
2055                 return idecd_set_spindown(&info->devinfo, arg);
2056         case CDROMGETSPINDOWN:
2057                 return idecd_get_spindown(&info->devinfo, arg);
2058         default:
2059                 break;
2060         }
2061
2062         err = generic_ide_ioctl(info->drive, file, bdev, cmd, arg);
2063         if (err == -EINVAL)
2064                 err = cdrom_ioctl(file, &info->devinfo, inode, cmd, arg);
2065
2066         return err;
2067 }
2068
2069 static int idecd_media_changed(struct gendisk *disk)
2070 {
2071         struct cdrom_info *info = ide_cd_g(disk);
2072         return cdrom_media_changed(&info->devinfo);
2073 }
2074
2075 static int idecd_revalidate_disk(struct gendisk *disk)
2076 {
2077         struct cdrom_info *info = ide_cd_g(disk);
2078         struct request_sense sense;
2079
2080         ide_cd_read_toc(info->drive, &sense);
2081
2082         return  0;
2083 }
2084
2085 static struct block_device_operations idecd_ops = {
2086         .owner                  = THIS_MODULE,
2087         .open                   = idecd_open,
2088         .release                = idecd_release,
2089         .ioctl                  = idecd_ioctl,
2090         .media_changed          = idecd_media_changed,
2091         .revalidate_disk        = idecd_revalidate_disk
2092 };
2093
2094 /* module options */
2095 static char *ignore;
2096
2097 module_param(ignore, charp, 0400);
2098 MODULE_DESCRIPTION("ATAPI CD-ROM Driver");
2099
2100 static int ide_cd_probe(ide_drive_t *drive)
2101 {
2102         struct cdrom_info *info;
2103         struct gendisk *g;
2104         struct request_sense sense;
2105
2106         if (!strstr("ide-cdrom", drive->driver_req))
2107                 goto failed;
2108         if (!drive->present)
2109                 goto failed;
2110         if (drive->media != ide_cdrom && drive->media != ide_optical)
2111                 goto failed;
2112         /* skip drives that we were told to ignore */
2113         if (ignore != NULL) {
2114                 if (strstr(ignore, drive->name)) {
2115                         printk(KERN_INFO "ide-cd: ignoring drive %s\n",
2116                                          drive->name);
2117                         goto failed;
2118                 }
2119         }
2120         if (drive->scsi) {
2121                 printk(KERN_INFO "ide-cd: passing drive %s to ide-scsi "
2122                                  "emulation.\n", drive->name);
2123                 goto failed;
2124         }
2125         info = kzalloc(sizeof(struct cdrom_info), GFP_KERNEL);
2126         if (info == NULL) {
2127                 printk(KERN_ERR "%s: Can't allocate a cdrom structure\n",
2128                                 drive->name);
2129                 goto failed;
2130         }
2131
2132         g = alloc_disk(1 << PARTN_BITS);
2133         if (!g)
2134                 goto out_free_cd;
2135
2136         ide_init_disk(g, drive);
2137
2138         ide_proc_register_driver(drive, &ide_cdrom_driver);
2139
2140         kref_init(&info->kref);
2141
2142         info->drive = drive;
2143         info->driver = &ide_cdrom_driver;
2144         info->disk = g;
2145
2146         g->private_data = &info->driver;
2147
2148         drive->driver_data = info;
2149
2150         g->minors = 1;
2151         g->driverfs_dev = &drive->gendev;
2152         g->flags = GENHD_FL_CD | GENHD_FL_REMOVABLE;
2153         if (ide_cdrom_setup(drive)) {
2154                 ide_proc_unregister_driver(drive, &ide_cdrom_driver);
2155                 ide_cd_release(&info->kref);
2156                 goto failed;
2157         }
2158
2159         ide_cd_read_toc(drive, &sense);
2160         g->fops = &idecd_ops;
2161         g->flags |= GENHD_FL_REMOVABLE;
2162         add_disk(g);
2163         return 0;
2164
2165 out_free_cd:
2166         kfree(info);
2167 failed:
2168         return -ENODEV;
2169 }
2170
2171 static void __exit ide_cdrom_exit(void)
2172 {
2173         driver_unregister(&ide_cdrom_driver.gen_driver);
2174 }
2175
2176 static int __init ide_cdrom_init(void)
2177 {
2178         return driver_register(&ide_cdrom_driver.gen_driver);
2179 }
2180
2181 MODULE_ALIAS("ide:*m-cdrom*");
2182 MODULE_ALIAS("ide-cd");
2183 module_init(ide_cdrom_init);
2184 module_exit(ide_cdrom_exit);
2185 MODULE_LICENSE("GPL");