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