1 /*
2 * linux/drivers/ide/ide-cd.c
3 *
4 * Copyright (C) 1994, 1995, 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 *
8 * May be copied or modified under the terms of the GNU General Public
9 * License. See linux/COPYING for more information.
10 *
11 * ATAPI CD-ROM driver. To be used with ide.c.
12 * See Documentation/cdrom/ide-cd for usage information.
13 *
14 * Suggestions are welcome. Patches that work are more welcome though. ;-)
15 * For those wishing to work on this driver, please be sure you download
16 * and comply with the latest Mt. Fuji (SFF8090 version 4) and ATAPI
17 * (SFF-8020i rev 2.6) standards. These documents can be obtained by
18 * anonymous ftp from:
19 * ftp://fission.dt.wdc.com/pub/standards/SFF_atapi/spec/SFF8020-r2.6/PS/8020r26.ps
20 * ftp://ftp.avc-pioneer.com/Mtfuji4/Spec/Fuji4r10.pdf
21 *
22 * Drives that deviate from these standards will be accommodated as much
23 * as possible via compile time or command-line options. Since I only have
24 * a few drives, you generally need to send me patches...
25 *
26 * ----------------------------------
27 * TO DO LIST:
28 * -Make it so that Pioneer CD DR-A24X and friends don't get screwed up on
29 * boot
30 *
31 * ----------------------------------
32 * 1.00 Oct 31, 1994 -- Initial version.
33 * 1.01 Nov 2, 1994 -- Fixed problem with starting request in
34 * cdrom_check_status.
35 * 1.03 Nov 25, 1994 -- leaving unmask_intr[] as a user-setting (as for disks)
36 * (from mlord) -- minor changes to cdrom_setup()
37 * -- renamed ide_dev_s to ide_drive_t, enable irq on command
38 * 2.00 Nov 27, 1994 -- Generalize packet command interface;
39 * add audio ioctls.
40 * 2.01 Dec 3, 1994 -- Rework packet command interface to handle devices
41 * which send an interrupt when ready for a command.
42 * 2.02 Dec 11, 1994 -- Cache the TOC in the driver.
43 * Don't use SCMD_PLAYAUDIO_TI; it's not included
44 * in the current version of ATAPI.
45 * Try to use LBA instead of track or MSF addressing
46 * when possible.
47 * Don't wait for READY_STAT.
48 * 2.03 Jan 10, 1995 -- Rewrite block read routines to handle block sizes
49 * other than 2k and to move multiple sectors in a
50 * single transaction.
51 * 2.04 Apr 21, 1995 -- Add work-around for Creative Labs CD220E drives.
52 * Thanks to Nick Saw <cwsaw@pts7.pts.mot.com> for
53 * help in figuring this out. Ditto for Acer and
54 * Aztech drives, which seem to have the same problem.
55 * 2.04b May 30, 1995 -- Fix to match changes in ide.c version 3.16 -ml
56 * 2.05 Jun 8, 1995 -- Don't attempt to retry after an illegal request
57 * or data protect error.
58 * Use HWIF and DEV_HWIF macros as in ide.c.
59 * Always try to do a request_sense after
60 * a failed command.
61 * Include an option to give textual descriptions
62 * of ATAPI errors.
63 * Fix a bug in handling the sector cache which
64 * showed up if the drive returned data in 512 byte
65 * blocks (like Pioneer drives). Thanks to
66 * Richard Hirst <srh@gpt.co.uk> for diagnosing this.
67 * Properly supply the page number field in the
68 * MODE_SELECT command.
69 * PLAYAUDIO12 is broken on the Aztech; work around it.
70 * 2.05x Aug 11, 1995 -- lots of data structure renaming/restructuring in ide.c
71 * (my apologies to Scott, but now ide-cd.c is independent)
72 * 3.00 Aug 22, 1995 -- Implement CDROMMULTISESSION ioctl.
73 * Implement CDROMREADAUDIO ioctl (UNTESTED).
74 * Use input_ide_data() and output_ide_data().
75 * Add door locking.
76 * Fix usage count leak in cdrom_open, which happened
77 * when a read-write mount was attempted.
78 * Try to load the disk on open.
79 * Implement CDROMEJECT_SW ioctl (off by default).
80 * Read total cdrom capacity during open.
81 * Rearrange logic in cdrom_decode_status. Issue
82 * request sense commands for failed packet commands
83 * from here instead of from cdrom_queue_packet_command.
84 * Fix a race condition in retrieving error information.
85 * Suppress printing normal unit attention errors and
86 * some drive not ready errors.
87 * Implement CDROMVOLREAD ioctl.
88 * Implement CDROMREADMODE1/2 ioctls.
89 * Fix race condition in setting up interrupt handlers
90 * when the `serialize' option is used.
91 * 3.01 Sep 2, 1995 -- Fix ordering of reenabling interrupts in
92 * cdrom_queue_request.
93 * Another try at using ide_[input,output]_data.
94 * 3.02 Sep 16, 1995 -- Stick total disk capacity in partition table as well.
95 * Make VERBOSE_IDE_CD_ERRORS dump failed command again.
96 * Dump out more information for ILLEGAL REQUEST errs.
97 * Fix handling of errors occurring before the
98 * packet command is transferred.
99 * Fix transfers with odd bytelengths.
100 * 3.03 Oct 27, 1995 -- Some Creative drives have an id of just `CD'.
101 * `DCI-2S10' drives are broken too.
102 * 3.04 Nov 20, 1995 -- So are Vertos drives.
103 * 3.05 Dec 1, 1995 -- Changes to go with overhaul of ide.c and ide-tape.c
104 * 3.06 Dec 16, 1995 -- Add support needed for partitions.
105 * More workarounds for Vertos bugs (based on patches
106 * from Holger Dietze <dietze@aix520.informatik.uni-leipzig.de>).
107 * Try to eliminate byteorder assumptions.
108 * Use atapi_cdrom_subchnl struct definition.
109 * Add STANDARD_ATAPI compilation option.
110 * 3.07 Jan 29, 1996 -- More twiddling for broken drives: Sony 55D,
111 * Vertos 300.
112 * Add NO_DOOR_LOCKING configuration option.
113 * Handle drive_cmd requests w/NULL args (for hdparm -t).
114 * Work around sporadic Sony55e audio play problem.
115 * 3.07a Feb 11, 1996 -- check drive->id for NULL before dereferencing, to fix
116 * problem with "hde=cdrom" with no drive present. -ml
117 * 3.08 Mar 6, 1996 -- More Vertos workarounds.
118 * 3.09 Apr 5, 1996 -- Add CDROMCLOSETRAY ioctl.
119 * Switch to using MSF addressing for audio commands.
120 * Reformat to match kernel tabbing style.
121 * Add CDROM_GET_UPC ioctl.
122 * 3.10 Apr 10, 1996 -- Fix compilation error with STANDARD_ATAPI.
123 * 3.11 Apr 29, 1996 -- Patch from Heiko Eissfeldt <heiko@colossus.escape.de>
124 * to remove redundant verify_area calls.
125 * 3.12 May 7, 1996 -- Rudimentary changer support. Based on patches
126 * from Gerhard Zuber <zuber@berlin.snafu.de>.
127 * Let open succeed even if there's no loaded disc.
128 * 3.13 May 19, 1996 -- Fixes for changer code.
129 * 3.14 May 29, 1996 -- Add work-around for Vertos 600.
130 * (From Hennus Bergman <hennus@sky.ow.nl>.)
131 * 3.15 July 2, 1996 -- Added support for Sanyo 3 CD changers
132 * from Ben Galliart <bgallia@luc.edu> with
133 * special help from Jeff Lightfoot
134 * <jeffml@pobox.com>
135 * 3.15a July 9, 1996 -- Improved Sanyo 3 CD changer identification
136 * 3.16 Jul 28, 1996 -- Fix from Gadi to reduce kernel stack usage for ioctl.
137 * 3.17 Sep 17, 1996 -- Tweak audio reads for some drives.
138 * Start changing CDROMLOADFROMSLOT to CDROM_SELECT_DISC.
139 * 3.18 Oct 31, 1996 -- Added module and DMA support.
140 *
141 *
142 * 4.00 Nov 5, 1996 -- New ide-cd maintainer,
143 * Erik B. Andersen <andersee@debian.org>
144 * -- Newer Creative drives don't always set the error
145 * register correctly. Make sure we see media changes
146 * regardless.
147 * -- Integrate with generic cdrom driver.
148 * -- CDROMGETSPINDOWN and CDROMSETSPINDOWN ioctls, based on
149 * a patch from Ciro Cattuto <>.
150 * -- Call set_device_ro.
151 * -- Implement CDROMMECHANISMSTATUS and CDROMSLOTTABLE
152 * ioctls, based on patch by Erik Andersen
153 * -- Add some probes of drive capability during setup.
154 *
155 * 4.01 Nov 11, 1996 -- Split into ide-cd.c and ide-cd.h
156 * -- Removed CDROMMECHANISMSTATUS and CDROMSLOTTABLE
157 * ioctls in favor of a generalized approach
158 * using the generic cdrom driver.
159 * -- Fully integrated with the 2.1.X kernel.
160 * -- Other stuff that I forgot (lots of changes)
161 *
162 * 4.02 Dec 01, 1996 -- Applied patch from Gadi Oxman <gadio@netvision.net.il>
163 * to fix the drive door locking problems.
164 *
165 * 4.03 Dec 04, 1996 -- Added DSC overlap support.
166 * 4.04 Dec 29, 1996 -- Added CDROMREADRAW ioclt based on patch
167 * by Ales Makarov (xmakarov@sun.felk.cvut.cz)
168 *
169 * 4.05 Nov 20, 1997 -- Modified to print more drive info on init
170 * Minor other changes
171 * Fix errors on CDROMSTOP (If you have a "Dolphin",
172 * you must define IHAVEADOLPHIN)
173 * Added identifier so new Sanyo CD-changer works
174 * Better detection if door locking isn't supported
175 *
176 * 4.06 Dec 17, 1997 -- fixed endless "tray open" messages -ml
177 * 4.07 Dec 17, 1997 -- fallback to set pc->stat on "tray open"
178 * 4.08 Dec 18, 1997 -- spew less noise when tray is empty
179 * -- fix speed display for ACER 24X, 18X
180 * 4.09 Jan 04, 1998 -- fix handling of the last block so we return
181 * an end of file instead of an I/O error (Gadi)
182 * 4.10 Jan 24, 1998 -- fixed a bug so now changers can change to a new
183 * slot when there is no disc in the current slot.
184 * -- Fixed a memory leak where info->changer_info was
185 * malloc'ed but never free'd when closing the device.
186 * -- Cleaned up the global namespace a bit by making more
187 * functions static that should already have been.
188 * 4.11 Mar 12, 1998 -- Added support for the CDROM_SELECT_SPEED ioctl
189 * based on a patch for 2.0.33 by Jelle Foks
190 * <jelle@scintilla.utwente.nl>, a patch for 2.0.33
191 * by Toni Giorgino <toni@pcape2.pi.infn.it>, the SCSI
192 * version, and my own efforts. -erik
193 * -- Fixed a stupid bug which egcs was kind enough to
194 * inform me of where "Illegal mode for this track"
195 * was never returned due to a comparison on data
196 * types of limited range.
197 * 4.12 Mar 29, 1998 -- Fixed bug in CDROM_SELECT_SPEED so write speed is
198 * now set ionly for CD-R and CD-RW drives. I had
199 * removed this support because it produced errors.
200 * It produced errors _only_ for non-writers. duh.
201 * 4.13 May 05, 1998 -- Suppress useless "in progress of becoming ready"
202 * messages, since this is not an error.
203 * -- Change error messages to be const
204 * -- Remove a "\t" which looks ugly in the syslogs
205 * 4.14 July 17, 1998 -- Change to pointing to .ps version of ATAPI spec
206 * since the .pdf version doesn't seem to work...
207 * -- Updated the TODO list to something more current.
208 *
209 * 4.15 Aug 25, 1998 -- Updated ide-cd.h to respect mechine endianess,
210 * patch thanks to "Eddie C. Dost" <ecd@skynet.be>
211 *
212 * 4.50 Oct 19, 1998 -- New maintainers!
213 * Jens Axboe <axboe@image.dk>
214 * Chris Zwilling <chris@cloudnet.com>
215 *
216 * 4.51 Dec 23, 1998 -- Jens Axboe <axboe@image.dk>
217 * - ide_cdrom_reset enabled since the ide subsystem
218 * handles resets fine now. <axboe@image.dk>
219 * - Transfer size fix for Samsung CD-ROMs, thanks to
220 * "Ville Hallik" <ville.hallik@mail.ee>.
221 * - other minor stuff.
222 *
223 * 4.52 Jan 19, 1999 -- Jens Axboe <axboe@image.dk>
224 * - Detect DVD-ROM/RAM drives
225 *
226 * 4.53 Feb 22, 1999 - Include other model Samsung and one Goldstar
227 * drive in transfer size limit.
228 * - Fix the I/O error when doing eject without a medium
229 * loaded on some drives.
230 * - CDROMREADMODE2 is now implemented through
231 * CDROMREADRAW, since many drives don't support
232 * MODE2 (even though ATAPI 2.6 says they must).
233 * - Added ignore parameter to ide-cd (as a module), eg
234 * insmod ide-cd ignore='hda hdb'
235 * Useful when using ide-cd in conjunction with
236 * ide-scsi. TODO: non-modular way of doing the
237 * same.
238 *
239 * 4.54 Aug 5, 1999 - Support for MMC2 class commands through the generic
240 * packet interface to cdrom.c.
241 * - Unified audio ioctl support, most of it.
242 * - cleaned up various deprecated verify_area().
243 * - Added ide_cdrom_packet() as the interface for
244 * the Uniform generic_packet().
245 * - bunch of other stuff, will fill in logs later.
246 * - report 1 slot for non-changers, like the other
247 * cd-rom drivers. don't report select disc for
248 * non-changers as well.
249 * - mask out audio playing, if the device can't do it.
250 *
251 * 4.55 Sep 1, 1999 - Eliminated the rest of the audio ioctls, except
252 * for CDROMREADTOC[ENTRY|HEADER]. Some of the drivers
253 * use this independently of the actual audio handling.
254 * They will disappear later when I get the time to
255 * do it cleanly.
256 * - Minimize the TOC reading - only do it when we
257 * know a media change has occurred.
258 * - Moved all the CDROMREADx ioctls to the Uniform layer.
259 * - Heiko Eissfeldt <heiko@colossus.escape.de> supplied
260 * some fixes for CDI.
261 * - CD-ROM leaving door locked fix from Andries
262 * Brouwer <Andries.Brouwer@cwi.nl>
263 * - Erik Andersen <andersen@xmission.com> unified
264 * commands across the various drivers and how
265 * sense errors are handled.
266 *
267 * 4.56 Sep 12, 1999 - Removed changer support - it is now in the
268 * Uniform layer.
269 * - Added partition based multisession handling.
270 * - Mode sense and mode select moved to the
271 * Uniform layer.
272 * - Fixed a problem with WPI CDS-32X drive - it
273 * failed the capabilities
274 *
275 * 4.57 Apr 7, 2000 - Fixed sense reporting.
276 * - Fixed possible oops in ide_cdrom_get_last_session()
277 * - Fix locking mania and make ide_cdrom_reset relock
278 * - Stop spewing errors to log when magicdev polls with
279 * TEST_UNIT_READY on some drives.
280 * - Various fixes from Tobias Ringstrom:
281 * tray if it was locked prior to the reset.
282 * - cdrom_read_capacity returns one frame too little.
283 * - Fix real capacity reporting.
284 *
285 * 4.58 May 1, 2000 - Clean up ACER50 stuff.
286 * - Fix small problem with ide_cdrom_capacity
287 *
288 * 4.59 Aug 11, 2000 - Fix changer problem in cdrom_read_toc, we weren't
289 * correctly sensing a disc change.
290 * - Rearranged some code
291 * - Use extended sense on drives that support it for
292 * correctly reporting tray status -- from
293 * Michael D Johnson <johnsom@orst.edu>
294 * 4.60 Dec 17, 2003 - Add mt rainier support
295 * - Bump timeout for packet commands, matches sr
296 * - Odd stuff
297 * 4.61 Jan 22, 2004 - support hardware sector sizes other than 2kB,
298 * Pascal Schmidt <der.eremit@email.de>
299 *
300 *************************************************************************/
301
302 #define IDECD_VERSION "4.61"
303
304 #include <linux/config.h>
305 #include <linux/module.h>
306 #include <linux/types.h>
307 #include <linux/kernel.h>
308 #include <linux/delay.h>
309 #include <linux/timer.h>
310 #include <linux/slab.h>
311 #include <linux/interrupt.h>
312 #include <linux/errno.h>
313 #include <linux/cdrom.h>
314 #include <linux/ide.h>
315 #include <linux/completion.h>
316 #include <linux/mutex.h>
317
318 #include <scsi/scsi.h> /* For SCSI -> ATAPI command conversion */
319
320 #include <asm/irq.h>
321 #include <asm/io.h>
322 #include <asm/byteorder.h>
323 #include <asm/uaccess.h>
324 #include <asm/unaligned.h>
325
326 #include "ide-cd.h"
327
328 static DEFINE_MUTEX(idecd_ref_mutex);
329
330 #define to_ide_cd(obj) container_of(obj, struct cdrom_info, kref)
331
332 #define ide_cd_g(disk) \
333 container_of((disk)->private_data, struct cdrom_info, driver)
334
335 static struct cdrom_info *ide_cd_get(struct gendisk *disk)
336 {
337 struct cdrom_info *cd = NULL;
338
339 mutex_lock(&idecd_ref_mutex);
340 cd = ide_cd_g(disk);
341 if (cd)
342 kref_get(&cd->kref);
343 mutex_unlock(&idecd_ref_mutex);
344 return cd;
345 }
346
347 static void ide_cd_release(struct kref *);
348
349 static void ide_cd_put(struct cdrom_info *cd)
350 {
351 mutex_lock(&idecd_ref_mutex);
352 kref_put(&cd->kref, ide_cd_release);
353 mutex_unlock(&idecd_ref_mutex);
354 }
355
356 /****************************************************************************
357 * Generic packet command support and error handling routines.
358 */
359
360 /* Mark that we've seen a media change, and invalidate our internal
361 buffers. */
362 static void cdrom_saw_media_change (ide_drive_t *drive)
363 {
364 struct cdrom_info *info = drive->driver_data;
365
366 CDROM_STATE_FLAGS (drive)->media_changed = 1;
367 CDROM_STATE_FLAGS (drive)->toc_valid = 0;
368 info->nsectors_buffered = 0;
369 }
370
371 static int cdrom_log_sense(ide_drive_t *drive, struct request *rq,
372 struct request_sense *sense)
373 {
374 int log = 0;
375
376 if (!sense || !rq || (rq->flags & REQ_QUIET))
377 return 0;
378
379 switch (sense->sense_key) {
380 case NO_SENSE: case RECOVERED_ERROR:
381 break;
382 case NOT_READY:
383 /*
384 * don't care about tray state messages for
385 * e.g. capacity commands or in-progress or
386 * becoming ready
387 */
388 if (sense->asc == 0x3a || sense->asc == 0x04)
389 break;
390 log = 1;
391 break;
392 case ILLEGAL_REQUEST:
393 /*
394 * don't log START_STOP unit with LoEj set, since
395 * we cannot reliably check if drive can auto-close
396 */
397 if (rq->cmd[0] == GPCMD_START_STOP_UNIT && sense->asc == 0x24)
398 log = 0;
399 break;
400 case UNIT_ATTENTION:
401 /*
402 * Make good and sure we've seen this potential media
403 * change. Some drives (i.e. Creative) fail to present
404 * the correct sense key in the error register.
405 */
406 cdrom_saw_media_change(drive);
407 break;
408 default:
409 log = 1;
410 break;
411 }
412 return log;
413 }
414
415 static
416 void cdrom_analyze_sense_data(ide_drive_t *drive,
417 struct request *failed_command,
418 struct request_sense *sense)
419 {
420 if (!cdrom_log_sense(drive, failed_command, sense))
421 return;
422
423 /*
424 * If a read toc is executed for a CD-R or CD-RW medium where
425 * the first toc has not been recorded yet, it will fail with
426 * 05/24/00 (which is a confusing error)
427 */
428 if (failed_command && failed_command->cmd[0] == GPCMD_READ_TOC_PMA_ATIP)
429 if (sense->sense_key == 0x05 && sense->asc == 0x24)
430 return;
431
432 #if VERBOSE_IDE_CD_ERRORS
433 {
434 int i;
435 const char *s = "bad sense key!";
436 char buf[80];
437
438 printk ("ATAPI device %s:\n", drive->name);
439 if (sense->error_code==0x70)
440 printk(" Error: ");
441 else if (sense->error_code==0x71)
442 printk(" Deferred Error: ");
443 else if (sense->error_code == 0x7f)
444 printk(" Vendor-specific Error: ");
445 else
446 printk(" Unknown Error Type: ");
447
448 if (sense->sense_key < ARY_LEN(sense_key_texts))
449 s = sense_key_texts[sense->sense_key];
450
451 printk("%s -- (Sense key=0x%02x)\n", s, sense->sense_key);
452
453 if (sense->asc == 0x40) {
454 sprintf(buf, "Diagnostic failure on component 0x%02x",
455 sense->ascq);
456 s = buf;
457 } else {
458 int lo = 0, mid, hi = ARY_LEN(sense_data_texts);
459 unsigned long key = (sense->sense_key << 16);
460 key |= (sense->asc << 8);
461 if (!(sense->ascq >= 0x80 && sense->ascq <= 0xdd))
462 key |= sense->ascq;
463 s = NULL;
464
465 while (hi > lo) {
466 mid = (lo + hi) / 2;
467 if (sense_data_texts[mid].asc_ascq == key ||
468 sense_data_texts[mid].asc_ascq == (0xff0000|key)) {
469 s = sense_data_texts[mid].text;
470 break;
471 }
472 else if (sense_data_texts[mid].asc_ascq > key)
473 hi = mid;
474 else
475 lo = mid+1;
476 }
477 }
478
479 if (s == NULL) {
480 if (sense->asc > 0x80)
481 s = "(vendor-specific error)";
482 else
483 s = "(reserved error code)";
484 }
485
486 printk(KERN_ERR " %s -- (asc=0x%02x, ascq=0x%02x)\n",
487 s, sense->asc, sense->ascq);
488
489 if (failed_command != NULL) {
490
491 int lo=0, mid, hi= ARY_LEN (packet_command_texts);
492 s = NULL;
493
494 while (hi > lo) {
495 mid = (lo + hi) / 2;
496 if (packet_command_texts[mid].packet_command ==
497 failed_command->cmd[0]) {
498 s = packet_command_texts[mid].text;
499 break;
500 }
501 if (packet_command_texts[mid].packet_command >
502 failed_command->cmd[0])
503 hi = mid;
504 else
505 lo = mid+1;
506 }
507
508 printk (KERN_ERR " The failed \"%s\" packet command was: \n \"", s);
509 for (i=0; i<sizeof (failed_command->cmd); i++)
510 printk ("%02x ", failed_command->cmd[i]);
511 printk ("\"\n");
512 }
513
514 /* The SKSV bit specifies validity of the sense_key_specific
515 * in the next two commands. It is bit 7 of the first byte.
516 * In the case of NOT_READY, if SKSV is set the drive can
517 * give us nice ETA readings.
518 */
519 if (sense->sense_key == NOT_READY && (sense->sks[0] & 0x80)) {
520 int progress = (sense->sks[1] << 8 | sense->sks[2]) * 100;
521 printk(KERN_ERR " Command is %02d%% complete\n", progress / 0xffff);
522
523 }
524
525 if (sense->sense_key == ILLEGAL_REQUEST &&
526 (sense->sks[0] & 0x80) != 0) {
527 printk(KERN_ERR " Error in %s byte %d",
528 (sense->sks[0] & 0x40) != 0 ?
529 "command packet" : "command data",
530 (sense->sks[1] << 8) + sense->sks[2]);
531
532 if ((sense->sks[0] & 0x40) != 0)
533 printk (" bit %d", sense->sks[0] & 0x07);
534
535 printk ("\n");
536 }
537 }
538
539 #else /* not VERBOSE_IDE_CD_ERRORS */
540
541 /* Suppress printing unit attention and `in progress of becoming ready'
542 errors when we're not being verbose. */
543
544 if (sense->sense_key == UNIT_ATTENTION ||
545 (sense->sense_key == NOT_READY && (sense->asc == 4 ||
546 sense->asc == 0x3a)))
547 return;
548
549 printk(KERN_ERR "%s: error code: 0x%02x sense_key: 0x%02x asc: 0x%02x ascq: 0x%02x\n",
550 drive->name,
551 sense->error_code, sense->sense_key,
552 sense->asc, sense->ascq);
553 #endif /* not VERBOSE_IDE_CD_ERRORS */
554 }
555
556 /*
557 * Initialize a ide-cd packet command request
558 */
559 static void cdrom_prepare_request(ide_drive_t *drive, struct request *rq)
560 {
561 struct cdrom_info *cd = drive->driver_data;
562
563 ide_init_drive_cmd(rq);
564 rq->flags = REQ_PC;
565 rq->rq_disk = cd->disk;
566 }
567
568 static void cdrom_queue_request_sense(ide_drive_t *drive, void *sense,
569 struct request *failed_command)
570 {
571 struct cdrom_info *info = drive->driver_data;
572 struct request *rq = &info->request_sense_request;
573
574 if (sense == NULL)
575 sense = &info->sense_data;
576
577 /* stuff the sense request in front of our current request */
578 cdrom_prepare_request(drive, rq);
579
580 rq->data = sense;
581 rq->cmd[0] = GPCMD_REQUEST_SENSE;
582 rq->cmd[4] = rq->data_len = 18;
583
584 rq->flags = REQ_SENSE;
585
586 /* NOTE! Save the failed command in "rq->buffer" */
587 rq->buffer = (void *) failed_command;
588
589 (void) ide_do_drive_cmd(drive, rq, ide_preempt);
590 }
591
592 static void cdrom_end_request (ide_drive_t *drive, int uptodate)
593 {
594 struct request *rq = HWGROUP(drive)->rq;
595 int nsectors = rq->hard_cur_sectors;
596
597 if ((rq->flags & REQ_SENSE) && uptodate) {
598 /*
599 * For REQ_SENSE, "rq->buffer" points to the original failed
600 * request
601 */
602 struct request *failed = (struct request *) rq->buffer;
603 struct cdrom_info *info = drive->driver_data;
604 void *sense = &info->sense_data;
605 unsigned long flags;
606
607 if (failed) {
608 if (failed->sense) {
609 sense = failed->sense;
610 failed->sense_len = rq->sense_len;
611 }
612
613 /*
614 * now end failed request
615 */
616 spin_lock_irqsave(&ide_lock, flags);
617 end_that_request_chunk(failed, 0, failed->data_len);
618 end_that_request_last(failed, 0);
619 spin_unlock_irqrestore(&ide_lock, flags);
620 }
621
622 cdrom_analyze_sense_data(drive, failed, sense);
623 }
624
625 if (!rq->current_nr_sectors && blk_fs_request(rq))
626 uptodate = 1;
627 /* make sure it's fully ended */
628 if (blk_pc_request(rq))
629 nsectors = (rq->data_len + 511) >> 9;
630 if (!nsectors)
631 nsectors = 1;
632
633 ide_end_request(drive, uptodate, nsectors);
634 }
635
636 /* Returns 0 if the request should be continued.
637 Returns 1 if the request was ended. */
638 static int cdrom_decode_status(ide_drive_t *drive, int good_stat, int *stat_ret)
639 {
640 struct request *rq = HWGROUP(drive)->rq;
641 int stat, err, sense_key;
642
643 /* Check for errors. */
644 stat = HWIF(drive)->INB(IDE_STATUS_REG);
645 if (stat_ret)
646 *stat_ret = stat;
647
648 if (OK_STAT(stat, good_stat, BAD_R_STAT))
649 return 0;
650
651 /* Get the IDE error register. */
652 err = HWIF(drive)->INB(IDE_ERROR_REG);
653 sense_key = err >> 4;
654
655 if (rq == NULL) {
656 printk("%s: missing rq in cdrom_decode_status\n", drive->name);
657 return 1;
658 }
659
660 if (rq->flags & REQ_SENSE) {
661 /* We got an error trying to get sense info
662 from the drive (probably while trying
663 to recover from a former error). Just give up. */
664
665 rq->flags |= REQ_FAILED;
666 cdrom_end_request(drive, 0);
667 ide_error(drive, "request sense failure", stat);
668 return 1;
669
670 } else if (rq->flags & (REQ_PC | REQ_BLOCK_PC)) {
671 /* All other functions, except for READ. */
672 unsigned long flags;
673
674 /*
675 * if we have an error, pass back CHECK_CONDITION as the
676 * scsi status byte
677 */
678 if ((rq->flags & REQ_BLOCK_PC) && !rq->errors)
679 rq->errors = SAM_STAT_CHECK_CONDITION;
680
681 /* Check for tray open. */
682 if (sense_key == NOT_READY) {
683 cdrom_saw_media_change (drive);
684 } else if (sense_key == UNIT_ATTENTION) {
685 /* Check for media change. */
686 cdrom_saw_media_change (drive);
687 /*printk("%s: media changed\n",drive->name);*/
688 return 0;
689 } else if (!(rq->flags & REQ_QUIET)) {
690 /* Otherwise, print an error. */
691 ide_dump_status(drive, "packet command error", stat);
692 }
693
694 rq->flags |= REQ_FAILED;
695
696 /*
697 * instead of playing games with moving completions around,
698 * remove failed request completely and end it when the
699 * request sense has completed
700 */
701 if (stat & ERR_STAT) {
702 spin_lock_irqsave(&ide_lock, flags);
703 blkdev_dequeue_request(rq);
704 HWGROUP(drive)->rq = NULL;
705 spin_unlock_irqrestore(&ide_lock, flags);
706
707 cdrom_queue_request_sense(drive, rq->sense, rq);
708 } else
709 cdrom_end_request(drive, 0);
710
711 } else if (blk_fs_request(rq)) {
712 int do_end_request = 0;
713
714 /* Handle errors from READ and WRITE requests. */
715
716 if (blk_noretry_request(rq))
717 do_end_request = 1;
718
719 if (sense_key == NOT_READY) {
720 /* Tray open. */
721 if (rq_data_dir(rq) == READ) {
722 cdrom_saw_media_change (drive);
723
724 /* Fail the request. */
725 printk ("%s: tray open\n", drive->name);
726 do_end_request = 1;
727 } else {
728 struct cdrom_info *info = drive->driver_data;
729
730 /* allow the drive 5 seconds to recover, some
731 * devices will return this error while flushing
732 * data from cache */
733 if (!rq->errors)
734 info->write_timeout = jiffies + ATAPI_WAIT_WRITE_BUSY;
735 rq->errors = 1;
736 if (time_after(jiffies, info->write_timeout))
737 do_end_request = 1;
738 else {
739 unsigned long flags;
740
741 /*
742 * take a breather relying on the
743 * unplug timer to kick us again
744 */
745 spin_lock_irqsave(&ide_lock, flags);
746 blk_plug_device(drive->queue);
747 spin_unlock_irqrestore(&ide_lock,flags);
748 return 1;
749 }
750 }
751 } else if (sense_key == UNIT_ATTENTION) {
752 /* Media change. */
753 cdrom_saw_media_change (drive);
754
755 /* Arrange to retry the request.
756 But be sure to give up if we've retried
757 too many times. */
758 if (++rq->errors > ERROR_MAX)
759 do_end_request = 1;
760 } else if (sense_key == ILLEGAL_REQUEST ||
761 sense_key == DATA_PROTECT) {
762 /* No point in retrying after an illegal
763 request or data protect error.*/
764 ide_dump_status (drive, "command error", stat);
765 do_end_request = 1;
766 } else if (sense_key == MEDIUM_ERROR) {
767 /* No point in re-trying a zillion times on a bad
768 * sector... If we got here the error is not correctable */
769 ide_dump_status (drive, "media error (bad sector)", stat);
770 do_end_request = 1;
771 } else if (sense_key == BLANK_CHECK) {
772 /* Disk appears blank ?? */
773 ide_dump_status (drive, "media error (blank)", stat);
774 do_end_request = 1;
775 } else if ((err & ~ABRT_ERR) != 0) {
776 /* Go to the default handler
777 for other errors. */
778 ide_error(drive, "cdrom_decode_status", stat);
779 return 1;
780 } else if ((++rq->errors > ERROR_MAX)) {
781 /* We've racked up too many retries. Abort. */
782 do_end_request = 1;
783 }
784
785 if (do_end_request)
786 cdrom_end_request(drive, 0);
787
788 /* If we got a CHECK_CONDITION status,
789 queue a request sense command. */
790 if ((stat & ERR_STAT) != 0)
791 cdrom_queue_request_sense(drive, NULL, NULL);
792 } else {
793 blk_dump_rq_flags(rq, "ide-cd: bad rq");
794 cdrom_end_request(drive, 0);
795 }
796
797 /* Retry, or handle the next request. */
798 return 1;
799 }
800
801 static int cdrom_timer_expiry(ide_drive_t *drive)
802 {
803 struct request *rq = HWGROUP(drive)->rq;
804 unsigned long wait = 0;
805
806 /*
807 * Some commands are *slow* and normally take a long time to
808 * complete. Usually we can use the ATAPI "disconnect" to bypass
809 * this, but not all commands/drives support that. Let
810 * ide_timer_expiry keep polling us for these.
811 */
812 switch (rq->cmd[0]) {
813 case GPCMD_BLANK:
814 case GPCMD_FORMAT_UNIT:
815 case GPCMD_RESERVE_RZONE_TRACK:
816 case GPCMD_CLOSE_TRACK:
817 case GPCMD_FLUSH_CACHE:
818 wait = ATAPI_WAIT_PC;
819 break;
820 default:
821 if (!(rq->flags & REQ_QUIET))
822 printk(KERN_INFO "ide-cd: cmd 0x%x timed out\n", rq->cmd[0]);
823 wait = 0;
824 break;
825 }
826 return wait;
827 }
828
829 /* Set up the device registers for transferring a packet command on DEV,
830 expecting to later transfer XFERLEN bytes. HANDLER is the routine
831 which actually transfers the command to the drive. If this is a
832 drq_interrupt device, this routine will arrange for HANDLER to be
833 called when the interrupt from the drive arrives. Otherwise, HANDLER
834 will be called immediately after the drive is prepared for the transfer. */
835
836 static ide_startstop_t cdrom_start_packet_command(ide_drive_t *drive,
837 int xferlen,
838 ide_handler_t *handler)
839 {
840 ide_startstop_t startstop;
841 struct cdrom_info *info = drive->driver_data;
842 ide_hwif_t *hwif = drive->hwif;
843
844 /* Wait for the controller to be idle. */
845 if (ide_wait_stat(&startstop, drive, 0, BUSY_STAT, WAIT_READY))
846 return startstop;
847
848 if (info->dma)
849 info->dma = !hwif->dma_setup(drive);
850
851 /* Set up the controller registers. */
852 /* FIXME: for Virtual DMA we must check harder */
853 HWIF(drive)->OUTB(info->dma, IDE_FEATURE_REG);
854 HWIF(drive)->OUTB(0, IDE_IREASON_REG);
855 HWIF(drive)->OUTB(0, IDE_SECTOR_REG);
856
857 HWIF(drive)->OUTB(xferlen & 0xff, IDE_BCOUNTL_REG);
858 HWIF(drive)->OUTB(xferlen >> 8 , IDE_BCOUNTH_REG);
859 if (IDE_CONTROL_REG)
860 HWIF(drive)->OUTB(drive->ctl, IDE_CONTROL_REG);
861
862 if (CDROM_CONFIG_FLAGS (drive)->drq_interrupt) {
863 /* packet command */
864 ide_execute_command(drive, WIN_PACKETCMD, handler, ATAPI_WAIT_PC, cdrom_timer_expiry);
865 return ide_started;
866 } else {
867 unsigned long flags;
868
869 /* packet command */
870 spin_lock_irqsave(&ide_lock, flags);
871 hwif->OUTBSYNC(drive, WIN_PACKETCMD, IDE_COMMAND_REG);
872 ndelay(400);
873 spin_unlock_irqrestore(&ide_lock, flags);
874
875 return (*handler) (drive);
876 }
877 }
878
879 /* Send a packet command to DRIVE described by CMD_BUF and CMD_LEN.
880 The device registers must have already been prepared
881 by cdrom_start_packet_command.
882 HANDLER is the interrupt handler to call when the command completes
883 or there's data ready. */
884 /*
885 * changed 5 parameters to 3 for dvd-ram
886 * struct packet_command *pc; now packet_command_t *pc;
887 */
888 #define ATAPI_MIN_CDB_BYTES 12
889 static ide_startstop_t cdrom_transfer_packet_command (ide_drive_t *drive,
890 struct request *rq,
891 ide_handler_t *handler)
892 {
893 ide_hwif_t *hwif = drive->hwif;
894 int cmd_len;
895 struct cdrom_info *info = drive->driver_data;
896 ide_startstop_t startstop;
897
898 if (CDROM_CONFIG_FLAGS(drive)->drq_interrupt) {
899 /* Here we should have been called after receiving an interrupt
900 from the device. DRQ should how be set. */
901
902 /* Check for errors. */
903 if (cdrom_decode_status(drive, DRQ_STAT, NULL))
904 return ide_stopped;
905 } else {
906 /* Otherwise, we must wait for DRQ to get set. */
907 if (ide_wait_stat(&startstop, drive, DRQ_STAT,
908 BUSY_STAT, WAIT_READY))
909 return startstop;
910 }
911
912 /* Arm the interrupt handler. */
913 ide_set_handler(drive, handler, rq->timeout, cdrom_timer_expiry);
914
915 /* ATAPI commands get padded out to 12 bytes minimum */
916 cmd_len = COMMAND_SIZE(rq->cmd[0]);
917 if (cmd_len < ATAPI_MIN_CDB_BYTES)
918 cmd_len = ATAPI_MIN_CDB_BYTES;
919
920 /* Send the command to the device. */
921 HWIF(drive)->atapi_output_bytes(drive, rq->cmd, cmd_len);
922
923 /* Start the DMA if need be */
924 if (info->dma)
925 hwif->dma_start(drive);
926
927 return ide_started;
928 }
929
930 /****************************************************************************
931 * Block read functions.
932 */
933
934 /*
935 * Buffer up to SECTORS_TO_TRANSFER sectors from the drive in our sector
936 * buffer. Once the first sector is added, any subsequent sectors are
937 * assumed to be continuous (until the buffer is cleared). For the first
938 * sector added, SECTOR is its sector number. (SECTOR is then ignored until
939 * the buffer is cleared.)
940 */
941 static void cdrom_buffer_sectors (ide_drive_t *drive, unsigned long sector,
942 int sectors_to_transfer)
943 {
944 struct cdrom_info *info = drive->driver_data;
945
946 /* Number of sectors to read into the buffer. */
947 int sectors_to_buffer = min_t(int, sectors_to_transfer,
948 (SECTOR_BUFFER_SIZE >> SECTOR_BITS) -
949 info->nsectors_buffered);
950
951 char *dest;
952
953 /* If we couldn't get a buffer, don't try to buffer anything... */
954 if (info->buffer == NULL)
955 sectors_to_buffer = 0;
956
957 /* If this is the first sector in the buffer, remember its number. */
958 if (info->nsectors_buffered == 0)
959 info->sector_buffered = sector;
960
961 /* Read the data into the buffer. */
962 dest = info->buffer + info->nsectors_buffered * SECTOR_SIZE;
963 while (sectors_to_buffer > 0) {
964 HWIF(drive)->atapi_input_bytes(drive, dest, SECTOR_SIZE);
965 --sectors_to_buffer;
966 --sectors_to_transfer;
967 ++info->nsectors_buffered;
968 dest += SECTOR_SIZE;
969 }
970
971 /* Throw away any remaining data. */
972 while (sectors_to_transfer > 0) {
973 static char dum[SECTOR_SIZE];
974 HWIF(drive)->atapi_input_bytes(drive, dum, sizeof (dum));
975 --sectors_to_transfer;
976 }
977 }
978
979 /*
980 * Check the contents of the interrupt reason register from the cdrom
981 * and attempt to recover if there are problems. Returns 0 if everything's
982 * ok; nonzero if the request has been terminated.
983 */
984 static
985 int cdrom_read_check_ireason (ide_drive_t *drive, int len, int ireason)
986 {
987 if (ireason == 2)
988 return 0;
989 else if (ireason == 0) {
990 /* Whoops... The drive is expecting to receive data from us! */
991 printk(KERN_ERR "%s: read_intr: Drive wants to transfer data the "
992 "wrong way!\n", drive->name);
993
994 /* Throw some data at the drive so it doesn't hang
995 and quit this request. */
996 while (len > 0) {
997 int dum = 0;
998 HWIF(drive)->atapi_output_bytes(drive, &dum, sizeof (dum));
999 len -= sizeof (dum);
1000 }