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 /* PIO data transfer routine using the scatter gather table. */
75 int ide_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
76 unsigned int bcount, int write)
78 ide_hwif_t *hwif = drive->hwif;
79 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
80 xfer_func_t *xf = write ? tp_ops->output_data : tp_ops->input_data;
81 struct scatterlist *sg = pc->sg;
86 count = min(sg->length - pc->b_count, bcount);
88 if (PageHighMem(sg_page(sg))) {
91 local_irq_save(flags);
92 buf = kmap_atomic(sg_page(sg), KM_IRQ0) + sg->offset;
93 xf(drive, NULL, buf + pc->b_count, count);
94 kunmap_atomic(buf - sg->offset, KM_IRQ0);
95 local_irq_restore(flags);
98 xf(drive, NULL, buf + pc->b_count, count);
102 pc->b_count += count;
105 if (pc->b_count == sg->length) {
108 pc->sg = sg = sg_next(sg);
114 printk(KERN_ERR "%s: %d leftover bytes, %s\n", drive->name,
115 bcount, write ? "padding with zeros"
116 : "discarding data");
117 ide_pad_transfer(drive, write, bcount);
122 EXPORT_SYMBOL_GPL(ide_io_buffers);
124 void ide_init_pc(struct ide_atapi_pc *pc)
126 memset(pc, 0, sizeof(*pc));
127 pc->buf = pc->pc_buf;
128 pc->buf_size = IDE_PC_BUFFER_SIZE;
130 EXPORT_SYMBOL_GPL(ide_init_pc);
133 * Generate a new packet command request in front of the request queue, before
134 * the current request, so that it will be processed immediately, on the next
135 * pass through the driver.
137 static void ide_queue_pc_head(ide_drive_t *drive, struct gendisk *disk,
138 struct ide_atapi_pc *pc, struct request *rq)
140 blk_rq_init(NULL, rq);
141 rq->cmd_type = REQ_TYPE_SPECIAL;
142 rq->cmd_flags |= REQ_PREEMPT;
143 rq->buffer = (char *)pc;
148 rq->data_len = pc->req_xfer;
151 memcpy(rq->cmd, pc->c, 12);
152 if (drive->media == ide_tape)
153 rq->cmd[13] = REQ_IDETAPE_PC1;
155 drive->hwif->rq = NULL;
157 elv_add_request(drive->queue, rq, ELEVATOR_INSERT_FRONT, 0);
161 * Add a special packet command request to the tail of the request queue,
162 * and wait for it to be serviced.
164 int ide_queue_pc_tail(ide_drive_t *drive, struct gendisk *disk,
165 struct ide_atapi_pc *pc)
170 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
171 rq->cmd_type = REQ_TYPE_SPECIAL;
172 rq->buffer = (char *)pc;
176 rq->data_len = pc->req_xfer;
179 memcpy(rq->cmd, pc->c, 12);
180 if (drive->media == ide_tape)
181 rq->cmd[13] = REQ_IDETAPE_PC1;
182 error = blk_execute_rq(drive->queue, disk, rq, 0);
187 EXPORT_SYMBOL_GPL(ide_queue_pc_tail);
189 int ide_do_test_unit_ready(ide_drive_t *drive, struct gendisk *disk)
191 struct ide_atapi_pc pc;
194 pc.c[0] = TEST_UNIT_READY;
196 return ide_queue_pc_tail(drive, disk, &pc);
198 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready);
200 int ide_do_start_stop(ide_drive_t *drive, struct gendisk *disk, int start)
202 struct ide_atapi_pc pc;
205 pc.c[0] = START_STOP;
208 if (drive->media == ide_tape)
209 pc.flags |= PC_FLAG_WAIT_FOR_DSC;
211 return ide_queue_pc_tail(drive, disk, &pc);
213 EXPORT_SYMBOL_GPL(ide_do_start_stop);
215 int ide_set_media_lock(ide_drive_t *drive, struct gendisk *disk, int on)
217 struct ide_atapi_pc pc;
219 if ((drive->dev_flags & IDE_DFLAG_DOORLOCKING) == 0)
223 pc.c[0] = ALLOW_MEDIUM_REMOVAL;
226 return ide_queue_pc_tail(drive, disk, &pc);
228 EXPORT_SYMBOL_GPL(ide_set_media_lock);
230 void ide_create_request_sense_cmd(ide_drive_t *drive, struct ide_atapi_pc *pc)
233 pc->c[0] = REQUEST_SENSE;
234 if (drive->media == ide_floppy) {
242 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd);
245 * Called when an error was detected during the last packet command.
246 * We queue a request sense packet command in the head of the request list.
248 void ide_retry_pc(ide_drive_t *drive, struct gendisk *disk)
250 struct request *rq = &drive->request_sense_rq;
251 struct ide_atapi_pc *pc = &drive->request_sense_pc;
253 (void)ide_read_error(drive);
254 ide_create_request_sense_cmd(drive, pc);
255 if (drive->media == ide_tape)
256 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
257 ide_queue_pc_head(drive, disk, pc, rq);
259 EXPORT_SYMBOL_GPL(ide_retry_pc);
261 int ide_cd_expiry(ide_drive_t *drive)
263 struct request *rq = drive->hwif->rq;
264 unsigned long wait = 0;
266 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__, rq->cmd[0]);
269 * Some commands are *slow* and normally take a long time to complete.
270 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
271 * commands/drives support that. Let ide_timer_expiry keep polling us
274 switch (rq->cmd[0]) {
276 case GPCMD_FORMAT_UNIT:
277 case GPCMD_RESERVE_RZONE_TRACK:
278 case GPCMD_CLOSE_TRACK:
279 case GPCMD_FLUSH_CACHE:
280 wait = ATAPI_WAIT_PC;
283 if (!(rq->cmd_flags & REQ_QUIET))
284 printk(KERN_INFO "cmd 0x%x timed out\n",
291 EXPORT_SYMBOL_GPL(ide_cd_expiry);
293 int ide_cd_get_xferlen(struct request *rq)
295 if (blk_fs_request(rq))
297 else if (blk_sense_request(rq) || blk_pc_request(rq) ||
298 rq->cmd_type == REQ_TYPE_ATA_PC)
303 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen);
305 void ide_read_bcount_and_ireason(ide_drive_t *drive, u16 *bcount, u8 *ireason)
309 memset(&cmd, 0, sizeof(cmd));
310 cmd.tf_flags = IDE_TFLAG_IN_LBAH | IDE_TFLAG_IN_LBAM |
313 drive->hwif->tp_ops->tf_read(drive, &cmd);
315 *bcount = (cmd.tf.lbah << 8) | cmd.tf.lbam;
316 *ireason = cmd.tf.nsect & 3;
318 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason);
321 * This is the usual interrupt handler which will be called during a packet
322 * command. We will transfer some of the data (as requested by the drive)
323 * and will re-point interrupt handler to us.
325 static ide_startstop_t ide_pc_intr(ide_drive_t *drive)
327 struct ide_atapi_pc *pc = drive->pc;
328 ide_hwif_t *hwif = drive->hwif;
329 struct request *rq = hwif->rq;
330 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
331 xfer_func_t *xferfunc;
332 unsigned int timeout, temp;
334 u8 stat, ireason, dsc = 0;
336 debug_log("Enter %s - interrupt handler\n", __func__);
338 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
341 /* Clear the interrupt */
342 stat = tp_ops->read_status(hwif);
344 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
345 int rc = hwif->dma_ops->dma_end(drive);
347 ide_destroy_dmatable(drive);
349 if (rc || (drive->media == ide_tape && (stat & ATA_ERR))) {
350 if (drive->media == ide_floppy)
351 printk(KERN_ERR "%s: DMA %s error\n",
352 drive->name, rq_data_dir(pc->rq)
354 pc->flags |= PC_FLAG_DMA_ERROR;
356 pc->xferred = pc->req_xfer;
357 if (drive->pc_update_buffers)
358 drive->pc_update_buffers(drive, pc);
360 debug_log("%s: DMA finished\n", drive->name);
363 /* No more interrupts */
364 if ((stat & ATA_DRQ) == 0) {
367 debug_log("Packet command completed, %d bytes transferred\n",
370 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
372 local_irq_enable_in_hardirq();
374 if (drive->media == ide_tape &&
375 (stat & ATA_ERR) && rq->cmd[0] == REQUEST_SENSE)
378 if ((stat & ATA_ERR) || (pc->flags & PC_FLAG_DMA_ERROR)) {
380 debug_log("%s: I/O error\n", drive->name);
382 if (drive->media != ide_tape)
385 if (rq->cmd[0] == REQUEST_SENSE) {
386 printk(KERN_ERR "%s: I/O error in request sense"
387 " command\n", drive->name);
388 return ide_do_reset(drive);
391 debug_log("[cmd %x]: check condition\n", rq->cmd[0]);
393 /* Retry operation */
394 ide_retry_pc(drive, rq->rq_disk);
396 /* queued, but not started */
401 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) && (stat & ATA_DSC) == 0)
404 /* Command finished - Call the callback function */
405 uptodate = drive->pc_callback(drive, dsc);
408 drive->failed_pc = NULL;
410 if (blk_special_request(rq)) {
412 ide_complete_rq(drive, 0, blk_rq_bytes(rq));
414 if (blk_fs_request(rq) == 0 && uptodate <= 0) {
418 ide_complete_rq(drive, uptodate ? 0 : -EIO,
425 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
426 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
427 printk(KERN_ERR "%s: The device wants to issue more interrupts "
428 "in DMA mode\n", drive->name);
430 return ide_do_reset(drive);
433 /* Get the number of bytes to transfer on this interrupt. */
434 ide_read_bcount_and_ireason(drive, &bcount, &ireason);
436 if (ireason & ATAPI_COD) {
437 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
438 return ide_do_reset(drive);
441 if (((ireason & ATAPI_IO) == ATAPI_IO) ==
442 !!(pc->flags & PC_FLAG_WRITING)) {
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 if (!(pc->flags & PC_FLAG_WRITING)) {
452 /* Reading - Check that we have enough space */
453 temp = pc->xferred + bcount;
454 if (temp > pc->req_xfer) {
455 if (temp > pc->buf_size) {
456 printk(KERN_ERR "%s: The device wants to send "
457 "us more data than expected - "
461 ide_pad_transfer(drive, 0, bcount);
464 debug_log("The device wants to send us more data than "
465 "expected - allowing transfer\n");
467 xferfunc = tp_ops->input_data;
469 xferfunc = tp_ops->output_data;
471 if ((drive->media == ide_floppy && !pc->buf) ||
472 (drive->media == ide_tape && pc->bh)) {
473 int done = drive->pc_io_buffers(drive, pc, bcount,
474 !!(pc->flags & PC_FLAG_WRITING));
476 /* FIXME: don't do partial completions */
477 if (drive->media == ide_floppy)
478 ide_complete_rq(drive, 0,
479 done ? done : ide_rq_bytes(rq));
481 xferfunc(drive, NULL, pc->cur_pos, bcount);
483 /* Update the current position */
484 pc->xferred += bcount;
485 pc->cur_pos += bcount;
487 debug_log("[cmd %x] transferred %d bytes on that intr.\n",
490 /* And set the interrupt handler again */
491 ide_set_handler(drive, ide_pc_intr, timeout);
495 static void ide_init_packet_cmd(struct ide_cmd *cmd, u32 tf_flags,
498 cmd->protocol = dma ? ATAPI_PROT_DMA : ATAPI_PROT_PIO;
499 cmd->tf_flags |= IDE_TFLAG_OUT_LBAH | IDE_TFLAG_OUT_LBAM |
500 IDE_TFLAG_OUT_FEATURE | tf_flags;
501 cmd->tf.command = ATA_CMD_PACKET;
502 cmd->tf.feature = dma; /* Use PIO/DMA */
503 cmd->tf.lbam = bcount & 0xff;
504 cmd->tf.lbah = (bcount >> 8) & 0xff;
507 static u8 ide_read_ireason(ide_drive_t *drive)
511 memset(&cmd, 0, sizeof(cmd));
512 cmd.tf_flags = IDE_TFLAG_IN_NSECT;
514 drive->hwif->tp_ops->tf_read(drive, &cmd);
516 return cmd.tf.nsect & 3;
519 static u8 ide_wait_ireason(ide_drive_t *drive, u8 ireason)
523 while (retries-- && ((ireason & ATAPI_COD) == 0 ||
524 (ireason & ATAPI_IO))) {
525 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
526 "a packet command, retrying\n", drive->name);
528 ireason = ide_read_ireason(drive);
530 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
531 "a packet command, ignoring\n",
533 ireason |= ATAPI_COD;
534 ireason &= ~ATAPI_IO;
541 static int ide_delayed_transfer_pc(ide_drive_t *drive)
543 /* Send the actual packet */
544 drive->hwif->tp_ops->output_data(drive, NULL, drive->pc->c, 12);
546 /* Timeout for the packet command */
547 return WAIT_FLOPPY_CMD;
550 static ide_startstop_t ide_transfer_pc(ide_drive_t *drive)
552 struct ide_atapi_pc *uninitialized_var(pc);
553 ide_hwif_t *hwif = drive->hwif;
554 struct request *rq = hwif->rq;
555 ide_expiry_t *expiry;
556 unsigned int timeout;
558 ide_startstop_t startstop;
561 if (ide_wait_stat(&startstop, drive, ATA_DRQ, ATA_BUSY, WAIT_READY)) {
562 printk(KERN_ERR "%s: Strange, packet command initiated yet "
563 "DRQ isn't asserted\n", drive->name);
567 if (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT) {
569 drive->waiting_for_dma = 1;
572 if (dev_is_idecd(drive)) {
573 /* ATAPI commands get padded out to 12 bytes minimum */
574 cmd_len = COMMAND_SIZE(rq->cmd[0]);
575 if (cmd_len < ATAPI_MIN_CDB_BYTES)
576 cmd_len = ATAPI_MIN_CDB_BYTES;
578 timeout = rq->timeout;
579 expiry = ide_cd_expiry;
583 cmd_len = ATAPI_MIN_CDB_BYTES;
586 * If necessary schedule the packet transfer to occur 'timeout'
587 * miliseconds later in ide_delayed_transfer_pc() after the
588 * device says it's ready for a packet.
590 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
591 timeout = drive->pc_delay;
592 expiry = &ide_delayed_transfer_pc;
594 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
599 ireason = ide_read_ireason(drive);
600 if (drive->media == ide_tape)
601 ireason = ide_wait_ireason(drive, ireason);
603 if ((ireason & ATAPI_COD) == 0 || (ireason & ATAPI_IO)) {
604 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
605 "a packet command\n", drive->name);
607 return ide_do_reset(drive);
611 hwif->expiry = expiry;
613 /* Set the interrupt routine */
614 ide_set_handler(drive,
615 (dev_is_idecd(drive) ? drive->irq_handler
619 /* Send the actual packet */
620 if ((drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) == 0)
621 hwif->tp_ops->output_data(drive, NULL, rq->cmd, cmd_len);
623 /* Begin DMA, if necessary */
624 if (dev_is_idecd(drive)) {
626 hwif->dma_ops->dma_start(drive);
628 if (pc->flags & PC_FLAG_DMA_OK) {
629 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
630 hwif->dma_ops->dma_start(drive);
637 ide_startstop_t ide_issue_pc(ide_drive_t *drive, struct ide_cmd *cmd)
639 struct ide_atapi_pc *pc;
640 ide_hwif_t *hwif = drive->hwif;
641 ide_expiry_t *expiry = NULL;
642 struct request *rq = hwif->rq;
643 unsigned int timeout;
646 u8 drq_int = !!(drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT);
648 if (dev_is_idecd(drive)) {
649 tf_flags = IDE_TFLAG_OUT_NSECT | IDE_TFLAG_OUT_LBAL;
650 bcount = ide_cd_get_xferlen(rq);
651 expiry = ide_cd_expiry;
652 timeout = ATAPI_WAIT_PC;
655 drive->dma = !ide_dma_prepare(drive, cmd);
659 /* We haven't transferred any data yet */
661 pc->cur_pos = pc->buf;
663 tf_flags = IDE_TFLAG_OUT_DEVICE;
664 bcount = ((drive->media == ide_tape) ?
666 min(pc->req_xfer, 63 * 1024));
668 if (pc->flags & PC_FLAG_DMA_ERROR) {
669 pc->flags &= ~PC_FLAG_DMA_ERROR;
673 if (pc->flags & PC_FLAG_DMA_OK)
674 drive->dma = !ide_dma_prepare(drive, cmd);
677 pc->flags &= ~PC_FLAG_DMA_OK;
679 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
683 ide_init_packet_cmd(cmd, tf_flags, bcount, drive->dma);
685 (void)do_rw_taskfile(drive, cmd);
689 drive->waiting_for_dma = 0;
690 hwif->expiry = expiry;
693 ide_execute_command(drive, cmd, ide_transfer_pc, timeout);
695 return drq_int ? ide_started : ide_transfer_pc(drive);
697 EXPORT_SYMBOL_GPL(ide_issue_pc);