Linux Audio

Check our new training course

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