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;
98 rq->data_len = pc->req_xfer;
101 memcpy(rq->cmd, pc->c, 12);
102 if (drive->media == ide_tape)
103 rq->cmd[13] = REQ_IDETAPE_PC1;
104 error = blk_execute_rq(drive->queue, disk, rq, 0);
109 EXPORT_SYMBOL_GPL(ide_queue_pc_tail);
111 int ide_do_test_unit_ready(ide_drive_t *drive, struct gendisk *disk)
113 struct ide_atapi_pc pc;
116 pc.c[0] = TEST_UNIT_READY;
118 return ide_queue_pc_tail(drive, disk, &pc);
120 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready);
122 int ide_do_start_stop(ide_drive_t *drive, struct gendisk *disk, int start)
124 struct ide_atapi_pc pc;
127 pc.c[0] = START_STOP;
130 if (drive->media == ide_tape)
131 pc.flags |= PC_FLAG_WAIT_FOR_DSC;
133 return ide_queue_pc_tail(drive, disk, &pc);
135 EXPORT_SYMBOL_GPL(ide_do_start_stop);
137 int ide_set_media_lock(ide_drive_t *drive, struct gendisk *disk, int on)
139 struct ide_atapi_pc pc;
141 if ((drive->dev_flags & IDE_DFLAG_DOORLOCKING) == 0)
145 pc.c[0] = ALLOW_MEDIUM_REMOVAL;
148 return ide_queue_pc_tail(drive, disk, &pc);
150 EXPORT_SYMBOL_GPL(ide_set_media_lock);
152 void ide_create_request_sense_cmd(ide_drive_t *drive, struct ide_atapi_pc *pc)
155 pc->c[0] = REQUEST_SENSE;
156 if (drive->media == ide_floppy) {
164 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd);
166 void ide_prep_sense(ide_drive_t *drive, struct request *rq)
168 struct request_sense *sense = &drive->sense_data;
169 struct request *sense_rq = &drive->sense_rq;
170 unsigned int cmd_len, sense_len;
172 debug_log("%s: enter\n", __func__);
174 switch (drive->media) {
188 BUG_ON(sense_len > sizeof(*sense));
190 if (blk_sense_request(rq) || drive->sense_rq_armed)
193 memset(sense, 0, sizeof(*sense));
195 blk_rq_init(rq->q, sense_rq);
196 sense_rq->rq_disk = rq->rq_disk;
198 sense_rq->data = sense;
199 sense_rq->cmd[0] = GPCMD_REQUEST_SENSE;
200 sense_rq->cmd[4] = cmd_len;
201 sense_rq->data_len = sense_len;
203 sense_rq->cmd_type = REQ_TYPE_SENSE;
204 sense_rq->cmd_flags |= REQ_PREEMPT;
206 if (drive->media == ide_tape)
207 sense_rq->cmd[13] = REQ_IDETAPE_PC1;
209 drive->sense_rq_armed = true;
211 EXPORT_SYMBOL_GPL(ide_prep_sense);
213 void ide_queue_sense_rq(ide_drive_t *drive, void *special)
215 BUG_ON(!drive->sense_rq_armed);
217 drive->sense_rq.special = special;
218 drive->sense_rq_armed = false;
220 drive->hwif->rq = NULL;
222 elv_add_request(drive->queue, &drive->sense_rq,
223 ELEVATOR_INSERT_FRONT, 0);
225 EXPORT_SYMBOL_GPL(ide_queue_sense_rq);
228 * Called when an error was detected during the last packet command.
229 * We queue a request sense packet command at the head of the request
232 void ide_retry_pc(ide_drive_t *drive)
234 struct request *sense_rq = &drive->sense_rq;
235 struct ide_atapi_pc *pc = &drive->request_sense_pc;
237 (void)ide_read_error(drive);
239 /* init pc from sense_rq */
241 memcpy(pc->c, sense_rq->cmd, 12);
242 pc->buf = sense_rq->data;
243 pc->req_xfer = sense_rq->data_len;
245 if (drive->media == ide_tape)
246 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
248 ide_queue_sense_rq(drive, pc);
250 EXPORT_SYMBOL_GPL(ide_retry_pc);
252 int ide_cd_expiry(ide_drive_t *drive)
254 struct request *rq = drive->hwif->rq;
255 unsigned long wait = 0;
257 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__, rq->cmd[0]);
260 * Some commands are *slow* and normally take a long time to complete.
261 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
262 * commands/drives support that. Let ide_timer_expiry keep polling us
265 switch (rq->cmd[0]) {
267 case GPCMD_FORMAT_UNIT:
268 case GPCMD_RESERVE_RZONE_TRACK:
269 case GPCMD_CLOSE_TRACK:
270 case GPCMD_FLUSH_CACHE:
271 wait = ATAPI_WAIT_PC;
274 if (!(rq->cmd_flags & REQ_QUIET))
275 printk(KERN_INFO "cmd 0x%x timed out\n",
282 EXPORT_SYMBOL_GPL(ide_cd_expiry);
284 int ide_cd_get_xferlen(struct request *rq)
286 if (blk_fs_request(rq))
288 else if (blk_sense_request(rq) || blk_pc_request(rq) ||
289 rq->cmd_type == REQ_TYPE_ATA_PC)
294 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen);
296 void ide_read_bcount_and_ireason(ide_drive_t *drive, u16 *bcount, u8 *ireason)
298 struct ide_taskfile tf;
300 drive->hwif->tp_ops->tf_read(drive, &tf, IDE_VALID_NSECT |
301 IDE_VALID_LBAM | IDE_VALID_LBAH);
303 *bcount = (tf.lbah << 8) | tf.lbam;
304 *ireason = tf.nsect & 3;
306 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason);
309 * This is the usual interrupt handler which will be called during a packet
310 * command. We will transfer some of the data (as requested by the drive)
311 * and will re-point interrupt handler to us.
313 static ide_startstop_t ide_pc_intr(ide_drive_t *drive)
315 struct ide_atapi_pc *pc = drive->pc;
316 ide_hwif_t *hwif = drive->hwif;
317 struct ide_cmd *cmd = &hwif->cmd;
318 struct request *rq = hwif->rq;
319 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
320 xfer_func_t *xferfunc;
321 unsigned int timeout, done;
323 u8 stat, ireason, dsc = 0;
324 u8 write = !!(pc->flags & PC_FLAG_WRITING);
326 debug_log("Enter %s - interrupt handler\n", __func__);
328 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
331 /* Clear the interrupt */
332 stat = tp_ops->read_status(hwif);
334 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
337 drive->waiting_for_dma = 0;
338 rc = hwif->dma_ops->dma_end(drive);
339 ide_dma_unmap_sg(drive, cmd);
341 if (rc || (drive->media == ide_tape && (stat & ATA_ERR))) {
342 if (drive->media == ide_floppy)
343 printk(KERN_ERR "%s: DMA %s error\n",
344 drive->name, rq_data_dir(pc->rq)
346 pc->flags |= PC_FLAG_DMA_ERROR;
348 pc->xferred = pc->req_xfer;
349 if (drive->pc_update_buffers)
350 drive->pc_update_buffers(drive, pc);
352 debug_log("%s: DMA finished\n", drive->name);
355 /* No more interrupts */
356 if ((stat & ATA_DRQ) == 0) {
360 debug_log("Packet command completed, %d bytes transferred\n",
363 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
365 local_irq_enable_in_hardirq();
367 if (drive->media == ide_tape &&
368 (stat & ATA_ERR) && rq->cmd[0] == REQUEST_SENSE)
371 if ((stat & ATA_ERR) || (pc->flags & PC_FLAG_DMA_ERROR)) {
373 debug_log("%s: I/O error\n", drive->name);
375 if (drive->media != ide_tape)
378 if (rq->cmd[0] == REQUEST_SENSE) {
379 printk(KERN_ERR "%s: I/O error in request sense"
380 " command\n", drive->name);
381 return ide_do_reset(drive);
384 debug_log("[cmd %x]: check condition\n", rq->cmd[0]);
386 /* Retry operation */
389 /* queued, but not started */
394 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) && (stat & ATA_DSC) == 0)
397 /* Command finished - Call the callback function */
398 uptodate = drive->pc_callback(drive, dsc);
401 drive->failed_pc = NULL;
403 if (blk_special_request(rq)) {
405 done = blk_rq_bytes(rq);
409 if (blk_fs_request(rq) == 0 && uptodate <= 0) {
414 if (drive->media == ide_tape)
415 done = ide_rq_bytes(rq); /* FIXME */
417 done = blk_rq_bytes(rq);
419 error = uptodate ? 0 : -EIO;
422 ide_complete_rq(drive, error, done);
426 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
427 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
428 printk(KERN_ERR "%s: The device wants to issue more interrupts "
429 "in DMA mode\n", drive->name);
431 return ide_do_reset(drive);
434 /* Get the number of bytes to transfer on this interrupt. */
435 ide_read_bcount_and_ireason(drive, &bcount, &ireason);
437 if (ireason & ATAPI_COD) {
438 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
439 return ide_do_reset(drive);
442 if (((ireason & ATAPI_IO) == ATAPI_IO) == write) {
443 /* Hopefully, we will never get here */
444 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
445 "to %s!\n", drive->name,
446 (ireason & ATAPI_IO) ? "Write" : "Read",
447 (ireason & ATAPI_IO) ? "Read" : "Write");
448 return ide_do_reset(drive);
451 xferfunc = write ? tp_ops->output_data : tp_ops->input_data;
453 if (drive->media == ide_floppy && pc->buf == NULL) {
454 done = min_t(unsigned int, bcount, cmd->nleft);
455 ide_pio_bytes(drive, cmd, write, done);
456 } else if (drive->media == ide_tape && pc->bh) {
457 done = drive->pc_io_buffers(drive, pc, bcount, write);
459 done = min_t(unsigned int, bcount, pc->req_xfer - pc->xferred);
460 xferfunc(drive, NULL, pc->cur_pos, done);
463 /* Update the current position */
470 ide_pad_transfer(drive, write, bcount);
472 debug_log("[cmd %x] transferred %d bytes, padded %d bytes\n",
473 rq->cmd[0], done, bcount);
475 /* And set the interrupt handler again */
476 ide_set_handler(drive, ide_pc_intr, timeout);
480 static void ide_init_packet_cmd(struct ide_cmd *cmd, u8 valid_tf,
483 cmd->protocol = dma ? ATAPI_PROT_DMA : ATAPI_PROT_PIO;
484 cmd->valid.out.tf = IDE_VALID_LBAH | IDE_VALID_LBAM |
485 IDE_VALID_FEATURE | valid_tf;
486 cmd->tf.command = ATA_CMD_PACKET;
487 cmd->tf.feature = dma; /* Use PIO/DMA */
488 cmd->tf.lbam = bcount & 0xff;
489 cmd->tf.lbah = (bcount >> 8) & 0xff;
492 static u8 ide_read_ireason(ide_drive_t *drive)
494 struct ide_taskfile tf;
496 drive->hwif->tp_ops->tf_read(drive, &tf, IDE_VALID_NSECT);
501 static u8 ide_wait_ireason(ide_drive_t *drive, u8 ireason)
505 while (retries-- && ((ireason & ATAPI_COD) == 0 ||
506 (ireason & ATAPI_IO))) {
507 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
508 "a packet command, retrying\n", drive->name);
510 ireason = ide_read_ireason(drive);
512 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
513 "a packet command, ignoring\n",
515 ireason |= ATAPI_COD;
516 ireason &= ~ATAPI_IO;
523 static int ide_delayed_transfer_pc(ide_drive_t *drive)
525 /* Send the actual packet */
526 drive->hwif->tp_ops->output_data(drive, NULL, drive->pc->c, 12);
528 /* Timeout for the packet command */
529 return WAIT_FLOPPY_CMD;
532 static ide_startstop_t ide_transfer_pc(ide_drive_t *drive)
534 struct ide_atapi_pc *uninitialized_var(pc);
535 ide_hwif_t *hwif = drive->hwif;
536 struct request *rq = hwif->rq;
537 ide_expiry_t *expiry;
538 unsigned int timeout;
540 ide_startstop_t startstop;
543 if (ide_wait_stat(&startstop, drive, ATA_DRQ, ATA_BUSY, WAIT_READY)) {
544 printk(KERN_ERR "%s: Strange, packet command initiated yet "
545 "DRQ isn't asserted\n", drive->name);
549 if (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT) {
551 drive->waiting_for_dma = 1;
554 if (dev_is_idecd(drive)) {
555 /* ATAPI commands get padded out to 12 bytes minimum */
556 cmd_len = COMMAND_SIZE(rq->cmd[0]);
557 if (cmd_len < ATAPI_MIN_CDB_BYTES)
558 cmd_len = ATAPI_MIN_CDB_BYTES;
560 timeout = rq->timeout;
561 expiry = ide_cd_expiry;
565 cmd_len = ATAPI_MIN_CDB_BYTES;
568 * If necessary schedule the packet transfer to occur 'timeout'
569 * miliseconds later in ide_delayed_transfer_pc() after the
570 * device says it's ready for a packet.
572 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
573 timeout = drive->pc_delay;
574 expiry = &ide_delayed_transfer_pc;
576 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
581 ireason = ide_read_ireason(drive);
582 if (drive->media == ide_tape)
583 ireason = ide_wait_ireason(drive, ireason);
585 if ((ireason & ATAPI_COD) == 0 || (ireason & ATAPI_IO)) {
586 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
587 "a packet command\n", drive->name);
589 return ide_do_reset(drive);
593 hwif->expiry = expiry;
595 /* Set the interrupt routine */
596 ide_set_handler(drive,
597 (dev_is_idecd(drive) ? drive->irq_handler
601 /* Send the actual packet */
602 if ((drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) == 0)
603 hwif->tp_ops->output_data(drive, NULL, rq->cmd, cmd_len);
605 /* Begin DMA, if necessary */
606 if (dev_is_idecd(drive)) {
608 hwif->dma_ops->dma_start(drive);
610 if (pc->flags & PC_FLAG_DMA_OK) {
611 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
612 hwif->dma_ops->dma_start(drive);
619 ide_startstop_t ide_issue_pc(ide_drive_t *drive, struct ide_cmd *cmd)
621 struct ide_atapi_pc *pc;
622 ide_hwif_t *hwif = drive->hwif;
623 ide_expiry_t *expiry = NULL;
624 struct request *rq = hwif->rq;
625 unsigned int timeout;
628 u8 drq_int = !!(drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT);
630 if (dev_is_idecd(drive)) {
631 valid_tf = IDE_VALID_NSECT | IDE_VALID_LBAL;
632 bcount = ide_cd_get_xferlen(rq);
633 expiry = ide_cd_expiry;
634 timeout = ATAPI_WAIT_PC;
637 drive->dma = !ide_dma_prepare(drive, cmd);
641 /* We haven't transferred any data yet */
643 pc->cur_pos = pc->buf;
645 valid_tf = IDE_VALID_DEVICE;
646 bcount = ((drive->media == ide_tape) ?
648 min(pc->req_xfer, 63 * 1024));
650 if (pc->flags & PC_FLAG_DMA_ERROR) {
651 pc->flags &= ~PC_FLAG_DMA_ERROR;
655 if (pc->flags & PC_FLAG_DMA_OK)
656 drive->dma = !ide_dma_prepare(drive, cmd);
659 pc->flags &= ~PC_FLAG_DMA_OK;
661 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
665 ide_init_packet_cmd(cmd, valid_tf, bcount, drive->dma);
667 (void)do_rw_taskfile(drive, cmd);
671 drive->waiting_for_dma = 0;
672 hwif->expiry = expiry;
675 ide_execute_command(drive, cmd, ide_transfer_pc, timeout);
677 return drq_int ? ide_started : ide_transfer_pc(drive);
679 EXPORT_SYMBOL_GPL(ide_issue_pc);