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