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