5 #include <linux/kernel.h>
6 #include <linux/cdrom.h>
7 #include <linux/delay.h>
9 #include <linux/scatterlist.h>
11 #include <scsi/scsi.h>
14 #define debug_log(fmt, args...) \
15 printk(KERN_INFO "ide: " fmt, ## args)
17 #define debug_log(fmt, args...) do {} while (0)
20 #define ATAPI_MIN_CDB_BYTES 12
22 static inline int dev_is_idecd(ide_drive_t *drive)
24 return drive->media == ide_cdrom || drive->media == ide_optical;
28 * Check whether we can support a device,
29 * based on the ATAPI IDENTIFY command results.
31 int ide_check_atapi_device(ide_drive_t *drive, const char *s)
34 u8 gcw[2], protocol, device_type, removable, drq_type, packet_size;
36 *((u16 *)&gcw) = id[ATA_ID_CONFIG];
38 protocol = (gcw[1] & 0xC0) >> 6;
39 device_type = gcw[1] & 0x1F;
40 removable = (gcw[0] & 0x80) >> 7;
41 drq_type = (gcw[0] & 0x60) >> 5;
42 packet_size = gcw[0] & 0x03;
45 /* kludge for Apple PowerBook internal zip */
46 if (drive->media == ide_floppy && device_type == 5 &&
47 !strstr((char *)&id[ATA_ID_PROD], "CD-ROM") &&
48 strstr((char *)&id[ATA_ID_PROD], "ZIP"))
53 printk(KERN_ERR "%s: %s: protocol (0x%02x) is not ATAPI\n",
54 s, drive->name, protocol);
55 else if ((drive->media == ide_floppy && device_type != 0) ||
56 (drive->media == ide_tape && device_type != 1))
57 printk(KERN_ERR "%s: %s: invalid device type (0x%02x)\n",
58 s, drive->name, device_type);
59 else if (removable == 0)
60 printk(KERN_ERR "%s: %s: the removable flag is not set\n",
62 else if (drive->media == ide_floppy && drq_type == 3)
63 printk(KERN_ERR "%s: %s: sorry, DRQ type (0x%02x) not "
64 "supported\n", s, drive->name, drq_type);
65 else if (packet_size != 0)
66 printk(KERN_ERR "%s: %s: packet size (0x%02x) is not 12 "
67 "bytes\n", s, drive->name, packet_size);
72 EXPORT_SYMBOL_GPL(ide_check_atapi_device);
74 void ide_init_pc(struct ide_atapi_pc *pc)
76 memset(pc, 0, sizeof(*pc));
78 pc->buf_size = IDE_PC_BUFFER_SIZE;
80 EXPORT_SYMBOL_GPL(ide_init_pc);
83 * Add a special packet command request to the tail of the request queue,
84 * and wait for it to be serviced.
86 int ide_queue_pc_tail(ide_drive_t *drive, struct gendisk *disk,
87 struct ide_atapi_pc *pc)
92 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
93 rq->cmd_type = REQ_TYPE_SPECIAL;
94 rq->special = (char *)pc;
97 error = blk_rq_map_kern(drive->queue, rq, pc->buf, pc->req_xfer,
103 memcpy(rq->cmd, pc->c, 12);
104 if (drive->media == ide_tape)
105 rq->cmd[13] = REQ_IDETAPE_PC1;
106 error = blk_execute_rq(drive->queue, disk, rq, 0);
111 EXPORT_SYMBOL_GPL(ide_queue_pc_tail);
113 int ide_do_test_unit_ready(ide_drive_t *drive, struct gendisk *disk)
115 struct ide_atapi_pc pc;
118 pc.c[0] = TEST_UNIT_READY;
120 return ide_queue_pc_tail(drive, disk, &pc);
122 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready);
124 int ide_do_start_stop(ide_drive_t *drive, struct gendisk *disk, int start)
126 struct ide_atapi_pc pc;
129 pc.c[0] = START_STOP;
132 if (drive->media == ide_tape)
133 pc.flags |= PC_FLAG_WAIT_FOR_DSC;
135 return ide_queue_pc_tail(drive, disk, &pc);
137 EXPORT_SYMBOL_GPL(ide_do_start_stop);
139 int ide_set_media_lock(ide_drive_t *drive, struct gendisk *disk, int on)
141 struct ide_atapi_pc pc;
143 if ((drive->dev_flags & IDE_DFLAG_DOORLOCKING) == 0)
147 pc.c[0] = ALLOW_MEDIUM_REMOVAL;
150 return ide_queue_pc_tail(drive, disk, &pc);
152 EXPORT_SYMBOL_GPL(ide_set_media_lock);
154 void ide_create_request_sense_cmd(ide_drive_t *drive, struct ide_atapi_pc *pc)
157 pc->c[0] = REQUEST_SENSE;
158 if (drive->media == ide_floppy) {
166 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd);
168 void ide_prep_sense(ide_drive_t *drive, struct request *rq)
170 struct request_sense *sense = &drive->sense_data;
171 struct request *sense_rq = &drive->sense_rq;
172 unsigned int cmd_len, sense_len;
175 switch (drive->media) {
189 BUG_ON(sense_len > sizeof(*sense));
191 if (blk_sense_request(rq) || drive->sense_rq_armed)
194 memset(sense, 0, sizeof(*sense));
196 blk_rq_init(rq->q, sense_rq);
198 err = blk_rq_map_kern(drive->queue, sense_rq, sense, sense_len,
201 if (printk_ratelimit())
202 printk(KERN_WARNING "%s: failed to map sense buffer\n",
207 sense_rq->rq_disk = rq->rq_disk;
208 sense_rq->cmd[0] = GPCMD_REQUEST_SENSE;
209 sense_rq->cmd[4] = cmd_len;
210 sense_rq->cmd_type = REQ_TYPE_SENSE;
211 sense_rq->cmd_flags |= REQ_PREEMPT;
213 if (drive->media == ide_tape)
214 sense_rq->cmd[13] = REQ_IDETAPE_PC1;
216 drive->sense_rq_armed = true;
218 EXPORT_SYMBOL_GPL(ide_prep_sense);
220 int ide_queue_sense_rq(ide_drive_t *drive, void *special)
222 /* deferred failure from ide_prep_sense() */
223 if (!drive->sense_rq_armed) {
224 printk(KERN_WARNING "%s: failed queue sense request\n",
229 drive->sense_rq.special = special;
230 drive->sense_rq_armed = false;
232 drive->hwif->rq = NULL;
234 elv_add_request(drive->queue, &drive->sense_rq,
235 ELEVATOR_INSERT_FRONT, 0);
238 EXPORT_SYMBOL_GPL(ide_queue_sense_rq);
241 * Called when an error was detected during the last packet command.
242 * We queue a request sense packet command at the head of the request
245 void ide_retry_pc(ide_drive_t *drive)
247 struct request *failed_rq = drive->hwif->rq;
248 struct request *sense_rq = &drive->sense_rq;
249 struct ide_atapi_pc *pc = &drive->request_sense_pc;
251 (void)ide_read_error(drive);
253 /* init pc from sense_rq */
255 memcpy(pc->c, sense_rq->cmd, 12);
256 pc->buf = bio_data(sense_rq->bio); /* pointer to mapped address */
257 pc->req_xfer = blk_rq_bytes(sense_rq);
259 if (drive->media == ide_tape)
260 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
263 * Push back the failed request and put request sense on top
264 * of it. The failed command will be retried after sense data
267 blk_requeue_request(failed_rq->q, failed_rq);
268 drive->hwif->rq = NULL;
269 if (ide_queue_sense_rq(drive, pc)) {
270 blk_start_request(failed_rq);
271 ide_complete_rq(drive, -EIO, blk_rq_bytes(failed_rq));
274 EXPORT_SYMBOL_GPL(ide_retry_pc);
276 int ide_cd_expiry(ide_drive_t *drive)
278 struct request *rq = drive->hwif->rq;
279 unsigned long wait = 0;
281 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__, rq->cmd[0]);
284 * Some commands are *slow* and normally take a long time to complete.
285 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
286 * commands/drives support that. Let ide_timer_expiry keep polling us
289 switch (rq->cmd[0]) {
291 case GPCMD_FORMAT_UNIT:
292 case GPCMD_RESERVE_RZONE_TRACK:
293 case GPCMD_CLOSE_TRACK:
294 case GPCMD_FLUSH_CACHE:
295 wait = ATAPI_WAIT_PC;
298 if (!(rq->cmd_flags & REQ_QUIET))
299 printk(KERN_INFO "cmd 0x%x timed out\n",
306 EXPORT_SYMBOL_GPL(ide_cd_expiry);
308 int ide_cd_get_xferlen(struct request *rq)
310 if (blk_fs_request(rq))
312 else if (blk_sense_request(rq) || blk_pc_request(rq) ||
313 rq->cmd_type == REQ_TYPE_ATA_PC)
314 return blk_rq_bytes(rq);
318 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen);
320 void ide_read_bcount_and_ireason(ide_drive_t *drive, u16 *bcount, u8 *ireason)
322 struct ide_taskfile tf;
324 drive->hwif->tp_ops->tf_read(drive, &tf, IDE_VALID_NSECT |
325 IDE_VALID_LBAM | IDE_VALID_LBAH);
327 *bcount = (tf.lbah << 8) | tf.lbam;
328 *ireason = tf.nsect & 3;
330 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason);
333 * This is the usual interrupt handler which will be called during a packet
334 * command. We will transfer some of the data (as requested by the drive)
335 * and will re-point interrupt handler to us.
337 static ide_startstop_t ide_pc_intr(ide_drive_t *drive)
339 struct ide_atapi_pc *pc = drive->pc;
340 ide_hwif_t *hwif = drive->hwif;
341 struct ide_cmd *cmd = &hwif->cmd;
342 struct request *rq = hwif->rq;
343 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
344 unsigned int timeout, done;
346 u8 stat, ireason, dsc = 0;
347 u8 write = !!(pc->flags & PC_FLAG_WRITING);
349 debug_log("Enter %s - interrupt handler\n", __func__);
351 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
354 /* Clear the interrupt */
355 stat = tp_ops->read_status(hwif);
357 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
360 drive->waiting_for_dma = 0;
361 rc = hwif->dma_ops->dma_end(drive);
362 ide_dma_unmap_sg(drive, cmd);
364 if (rc || (drive->media == ide_tape && (stat & ATA_ERR))) {
365 if (drive->media == ide_floppy)
366 printk(KERN_ERR "%s: DMA %s error\n",
367 drive->name, rq_data_dir(pc->rq)
369 pc->flags |= PC_FLAG_DMA_ERROR;
372 debug_log("%s: DMA finished\n", drive->name);
375 /* No more interrupts */
376 if ((stat & ATA_DRQ) == 0) {
379 debug_log("Packet command completed, %d bytes transferred\n",
382 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
384 local_irq_enable_in_hardirq();
386 if (drive->media == ide_tape &&
387 (stat & ATA_ERR) && rq->cmd[0] == REQUEST_SENSE)
390 if ((stat & ATA_ERR) || (pc->flags & PC_FLAG_DMA_ERROR)) {
392 debug_log("%s: I/O error\n", drive->name);
394 if (drive->media != ide_tape)
397 if (rq->cmd[0] == REQUEST_SENSE) {
398 printk(KERN_ERR "%s: I/O error in request sense"
399 " command\n", drive->name);
400 return ide_do_reset(drive);
403 debug_log("[cmd %x]: check condition\n", rq->cmd[0]);
405 /* Retry operation */
408 /* queued, but not started */
413 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) && (stat & ATA_DSC) == 0)
416 /* Command finished - Call the callback function */
417 uptodate = drive->pc_callback(drive, dsc);
420 drive->failed_pc = NULL;
422 if (blk_special_request(rq)) {
427 if (blk_fs_request(rq) == 0 && uptodate <= 0) {
432 error = uptodate ? 0 : -EIO;
435 ide_complete_rq(drive, error, blk_rq_bytes(rq));
439 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
440 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
441 printk(KERN_ERR "%s: The device wants to issue more interrupts "
442 "in DMA mode\n", drive->name);
444 return ide_do_reset(drive);
447 /* Get the number of bytes to transfer on this interrupt. */
448 ide_read_bcount_and_ireason(drive, &bcount, &ireason);
450 if (ireason & ATAPI_COD) {
451 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
452 return ide_do_reset(drive);
455 if (((ireason & ATAPI_IO) == ATAPI_IO) == write) {
456 /* Hopefully, we will never get here */
457 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
458 "to %s!\n", drive->name,
459 (ireason & ATAPI_IO) ? "Write" : "Read",
460 (ireason & ATAPI_IO) ? "Read" : "Write");
461 return ide_do_reset(drive);
464 done = min_t(unsigned int, bcount, cmd->nleft);
465 ide_pio_bytes(drive, cmd, write, done);
467 /* Update transferred byte count */
468 rq->resid_len -= done;
473 ide_pad_transfer(drive, write, bcount);
475 debug_log("[cmd %x] transferred %d bytes, padded %d bytes, resid: %u\n",
476 rq->cmd[0], done, bcount, rq->resid_len);
478 /* And set the interrupt handler again */
479 ide_set_handler(drive, ide_pc_intr, timeout);
483 static void ide_init_packet_cmd(struct ide_cmd *cmd, u8 valid_tf,
486 cmd->protocol = dma ? ATAPI_PROT_DMA : ATAPI_PROT_PIO;
487 cmd->valid.out.tf = IDE_VALID_LBAH | IDE_VALID_LBAM |
488 IDE_VALID_FEATURE | valid_tf;
489 cmd->tf.command = ATA_CMD_PACKET;
490 cmd->tf.feature = dma; /* Use PIO/DMA */
491 cmd->tf.lbam = bcount & 0xff;
492 cmd->tf.lbah = (bcount >> 8) & 0xff;
495 static u8 ide_read_ireason(ide_drive_t *drive)
497 struct ide_taskfile tf;
499 drive->hwif->tp_ops->tf_read(drive, &tf, IDE_VALID_NSECT);
504 static u8 ide_wait_ireason(ide_drive_t *drive, u8 ireason)
508 while (retries-- && ((ireason & ATAPI_COD) == 0 ||
509 (ireason & ATAPI_IO))) {
510 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
511 "a packet command, retrying\n", drive->name);
513 ireason = ide_read_ireason(drive);
515 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
516 "a packet command, ignoring\n",
518 ireason |= ATAPI_COD;
519 ireason &= ~ATAPI_IO;
526 static int ide_delayed_transfer_pc(ide_drive_t *drive)
528 /* Send the actual packet */
529 drive->hwif->tp_ops->output_data(drive, NULL, drive->pc->c, 12);
531 /* Timeout for the packet command */
532 return WAIT_FLOPPY_CMD;
535 static ide_startstop_t ide_transfer_pc(ide_drive_t *drive)
537 struct ide_atapi_pc *uninitialized_var(pc);
538 ide_hwif_t *hwif = drive->hwif;
539 struct request *rq = hwif->rq;
540 ide_expiry_t *expiry;
541 unsigned int timeout;
543 ide_startstop_t startstop;
546 if (ide_wait_stat(&startstop, drive, ATA_DRQ, ATA_BUSY, WAIT_READY)) {
547 printk(KERN_ERR "%s: Strange, packet command initiated yet "
548 "DRQ isn't asserted\n", drive->name);
552 if (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT) {
554 drive->waiting_for_dma = 1;
557 if (dev_is_idecd(drive)) {
558 /* ATAPI commands get padded out to 12 bytes minimum */
559 cmd_len = COMMAND_SIZE(rq->cmd[0]);
560 if (cmd_len < ATAPI_MIN_CDB_BYTES)
561 cmd_len = ATAPI_MIN_CDB_BYTES;
563 timeout = rq->timeout;
564 expiry = ide_cd_expiry;
568 cmd_len = ATAPI_MIN_CDB_BYTES;
571 * If necessary schedule the packet transfer to occur 'timeout'
572 * miliseconds later in ide_delayed_transfer_pc() after the
573 * device says it's ready for a packet.
575 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
576 timeout = drive->pc_delay;
577 expiry = &ide_delayed_transfer_pc;
579 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
584 ireason = ide_read_ireason(drive);
585 if (drive->media == ide_tape)
586 ireason = ide_wait_ireason(drive, ireason);
588 if ((ireason & ATAPI_COD) == 0 || (ireason & ATAPI_IO)) {
589 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
590 "a packet command\n", drive->name);
592 return ide_do_reset(drive);
596 hwif->expiry = expiry;
598 /* Set the interrupt routine */
599 ide_set_handler(drive,
600 (dev_is_idecd(drive) ? drive->irq_handler
604 /* Send the actual packet */
605 if ((drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) == 0)
606 hwif->tp_ops->output_data(drive, NULL, rq->cmd, cmd_len);
608 /* Begin DMA, if necessary */
609 if (dev_is_idecd(drive)) {
611 hwif->dma_ops->dma_start(drive);
613 if (pc->flags & PC_FLAG_DMA_OK) {
614 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
615 hwif->dma_ops->dma_start(drive);
622 ide_startstop_t ide_issue_pc(ide_drive_t *drive, struct ide_cmd *cmd)
624 struct ide_atapi_pc *pc;
625 ide_hwif_t *hwif = drive->hwif;
626 ide_expiry_t *expiry = NULL;
627 struct request *rq = hwif->rq;
628 unsigned int timeout, bytes;
631 u8 drq_int = !!(drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT);
633 if (dev_is_idecd(drive)) {
634 valid_tf = IDE_VALID_NSECT | IDE_VALID_LBAL;
635 bcount = ide_cd_get_xferlen(rq);
636 expiry = ide_cd_expiry;
637 timeout = ATAPI_WAIT_PC;
640 drive->dma = !ide_dma_prepare(drive, cmd);
644 valid_tf = IDE_VALID_DEVICE;
645 bytes = blk_rq_bytes(rq);
646 bcount = ((drive->media == ide_tape) ? bytes
647 : min_t(unsigned int,
650 /* We haven't transferred any data yet */
651 rq->resid_len = bcount;
653 if (pc->flags & PC_FLAG_DMA_ERROR) {
654 pc->flags &= ~PC_FLAG_DMA_ERROR;
658 if (pc->flags & PC_FLAG_DMA_OK)
659 drive->dma = !ide_dma_prepare(drive, cmd);
662 pc->flags &= ~PC_FLAG_DMA_OK;
664 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
668 ide_init_packet_cmd(cmd, valid_tf, bcount, drive->dma);
670 (void)do_rw_taskfile(drive, cmd);
674 drive->waiting_for_dma = 0;
675 hwif->expiry = expiry;
678 ide_execute_command(drive, cmd, ide_transfer_pc, timeout);
680 return drq_int ? ide_started : ide_transfer_pc(drive);
682 EXPORT_SYMBOL_GPL(ide_issue_pc);