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 * Generate a new packet command request in front of the request queue, before
84 * the current request, so that it will be processed immediately, on the next
85 * pass through the driver.
87 static void ide_queue_pc_head(ide_drive_t *drive, struct gendisk *disk,
88 struct ide_atapi_pc *pc, struct request *rq)
90 blk_rq_init(NULL, rq);
91 rq->cmd_type = REQ_TYPE_SPECIAL;
92 rq->cmd_flags |= REQ_PREEMPT;
93 rq->buffer = (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;
105 drive->hwif->rq = NULL;
107 elv_add_request(drive->queue, rq, ELEVATOR_INSERT_FRONT, 0);
111 * Add a special packet command request to the tail of the request queue,
112 * and wait for it to be serviced.
114 int ide_queue_pc_tail(ide_drive_t *drive, struct gendisk *disk,
115 struct ide_atapi_pc *pc)
120 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
121 rq->cmd_type = REQ_TYPE_SPECIAL;
122 rq->buffer = (char *)pc;
126 rq->data_len = pc->req_xfer;
129 memcpy(rq->cmd, pc->c, 12);
130 if (drive->media == ide_tape)
131 rq->cmd[13] = REQ_IDETAPE_PC1;
132 error = blk_execute_rq(drive->queue, disk, rq, 0);
137 EXPORT_SYMBOL_GPL(ide_queue_pc_tail);
139 int ide_do_test_unit_ready(ide_drive_t *drive, struct gendisk *disk)
141 struct ide_atapi_pc pc;
144 pc.c[0] = TEST_UNIT_READY;
146 return ide_queue_pc_tail(drive, disk, &pc);
148 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready);
150 int ide_do_start_stop(ide_drive_t *drive, struct gendisk *disk, int start)
152 struct ide_atapi_pc pc;
155 pc.c[0] = START_STOP;
158 if (drive->media == ide_tape)
159 pc.flags |= PC_FLAG_WAIT_FOR_DSC;
161 return ide_queue_pc_tail(drive, disk, &pc);
163 EXPORT_SYMBOL_GPL(ide_do_start_stop);
165 int ide_set_media_lock(ide_drive_t *drive, struct gendisk *disk, int on)
167 struct ide_atapi_pc pc;
169 if ((drive->dev_flags & IDE_DFLAG_DOORLOCKING) == 0)
173 pc.c[0] = ALLOW_MEDIUM_REMOVAL;
176 return ide_queue_pc_tail(drive, disk, &pc);
178 EXPORT_SYMBOL_GPL(ide_set_media_lock);
180 void ide_create_request_sense_cmd(ide_drive_t *drive, struct ide_atapi_pc *pc)
183 pc->c[0] = REQUEST_SENSE;
184 if (drive->media == ide_floppy) {
192 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd);
195 * Called when an error was detected during the last packet command.
196 * We queue a request sense packet command in the head of the request list.
198 void ide_retry_pc(ide_drive_t *drive, struct gendisk *disk)
200 struct request *rq = &drive->request_sense_rq;
201 struct ide_atapi_pc *pc = &drive->request_sense_pc;
203 (void)ide_read_error(drive);
204 ide_create_request_sense_cmd(drive, pc);
205 if (drive->media == ide_tape)
206 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
207 ide_queue_pc_head(drive, disk, pc, rq);
209 EXPORT_SYMBOL_GPL(ide_retry_pc);
211 int ide_cd_expiry(ide_drive_t *drive)
213 struct request *rq = drive->hwif->rq;
214 unsigned long wait = 0;
216 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__, rq->cmd[0]);
219 * Some commands are *slow* and normally take a long time to complete.
220 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
221 * commands/drives support that. Let ide_timer_expiry keep polling us
224 switch (rq->cmd[0]) {
226 case GPCMD_FORMAT_UNIT:
227 case GPCMD_RESERVE_RZONE_TRACK:
228 case GPCMD_CLOSE_TRACK:
229 case GPCMD_FLUSH_CACHE:
230 wait = ATAPI_WAIT_PC;
233 if (!(rq->cmd_flags & REQ_QUIET))
234 printk(KERN_INFO "cmd 0x%x timed out\n",
241 EXPORT_SYMBOL_GPL(ide_cd_expiry);
243 int ide_cd_get_xferlen(struct request *rq)
245 if (blk_fs_request(rq))
247 else if (blk_sense_request(rq) || blk_pc_request(rq) ||
248 rq->cmd_type == REQ_TYPE_ATA_PC)
253 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen);
255 void ide_read_bcount_and_ireason(ide_drive_t *drive, u16 *bcount, u8 *ireason)
259 memset(&cmd, 0, sizeof(cmd));
260 cmd.tf_flags = IDE_TFLAG_IN_LBAH | IDE_TFLAG_IN_LBAM |
263 drive->hwif->tp_ops->tf_read(drive, &cmd);
265 *bcount = (cmd.tf.lbah << 8) | cmd.tf.lbam;
266 *ireason = cmd.tf.nsect & 3;
268 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason);
271 * This is the usual interrupt handler which will be called during a packet
272 * command. We will transfer some of the data (as requested by the drive)
273 * and will re-point interrupt handler to us.
275 static ide_startstop_t ide_pc_intr(ide_drive_t *drive)
277 struct ide_atapi_pc *pc = drive->pc;
278 ide_hwif_t *hwif = drive->hwif;
279 struct ide_cmd *cmd = &hwif->cmd;
280 struct request *rq = hwif->rq;
281 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
282 xfer_func_t *xferfunc;
283 unsigned int timeout, done;
285 u8 stat, ireason, dsc = 0;
286 u8 write = !!(pc->flags & PC_FLAG_WRITING);
288 debug_log("Enter %s - interrupt handler\n", __func__);
290 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
293 /* Clear the interrupt */
294 stat = tp_ops->read_status(hwif);
296 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
299 drive->waiting_for_dma = 0;
300 rc = hwif->dma_ops->dma_end(drive);
301 ide_dma_unmap_sg(drive, cmd);
303 if (rc || (drive->media == ide_tape && (stat & ATA_ERR))) {
304 if (drive->media == ide_floppy)
305 printk(KERN_ERR "%s: DMA %s error\n",
306 drive->name, rq_data_dir(pc->rq)
308 pc->flags |= PC_FLAG_DMA_ERROR;
310 pc->xferred = pc->req_xfer;
311 if (drive->pc_update_buffers)
312 drive->pc_update_buffers(drive, pc);
314 debug_log("%s: DMA finished\n", drive->name);
317 /* No more interrupts */
318 if ((stat & ATA_DRQ) == 0) {
322 debug_log("Packet command completed, %d bytes transferred\n",
325 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
327 local_irq_enable_in_hardirq();
329 if (drive->media == ide_tape &&
330 (stat & ATA_ERR) && rq->cmd[0] == REQUEST_SENSE)
333 if ((stat & ATA_ERR) || (pc->flags & PC_FLAG_DMA_ERROR)) {
335 debug_log("%s: I/O error\n", drive->name);
337 if (drive->media != ide_tape)
340 if (rq->cmd[0] == REQUEST_SENSE) {
341 printk(KERN_ERR "%s: I/O error in request sense"
342 " command\n", drive->name);
343 return ide_do_reset(drive);
346 debug_log("[cmd %x]: check condition\n", rq->cmd[0]);
348 /* Retry operation */
349 ide_retry_pc(drive, rq->rq_disk);
351 /* queued, but not started */
356 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) && (stat & ATA_DSC) == 0)
359 /* Command finished - Call the callback function */
360 uptodate = drive->pc_callback(drive, dsc);
363 drive->failed_pc = NULL;
365 if (blk_special_request(rq)) {
367 done = blk_rq_bytes(rq);
371 if (blk_fs_request(rq) == 0 && uptodate <= 0) {
376 if (drive->media == ide_tape)
377 done = ide_rq_bytes(rq); /* FIXME */
379 done = blk_rq_bytes(rq);
381 error = uptodate ? 0 : -EIO;
384 ide_complete_rq(drive, error, done);
388 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
389 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
390 printk(KERN_ERR "%s: The device wants to issue more interrupts "
391 "in DMA mode\n", drive->name);
393 return ide_do_reset(drive);
396 /* Get the number of bytes to transfer on this interrupt. */
397 ide_read_bcount_and_ireason(drive, &bcount, &ireason);
399 if (ireason & ATAPI_COD) {
400 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
401 return ide_do_reset(drive);
404 if (((ireason & ATAPI_IO) == ATAPI_IO) == write) {
405 /* Hopefully, we will never get here */
406 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
407 "to %s!\n", drive->name,
408 (ireason & ATAPI_IO) ? "Write" : "Read",
409 (ireason & ATAPI_IO) ? "Read" : "Write");
410 return ide_do_reset(drive);
413 xferfunc = write ? tp_ops->output_data : tp_ops->input_data;
415 if (drive->media == ide_floppy && pc->buf == NULL) {
416 done = min_t(unsigned int, bcount, cmd->nleft);
417 ide_pio_bytes(drive, cmd, write, done);
418 } else if (drive->media == ide_tape && pc->bh) {
419 done = drive->pc_io_buffers(drive, pc, bcount, write);
421 done = min_t(unsigned int, bcount, pc->req_xfer - pc->xferred);
422 xferfunc(drive, NULL, pc->cur_pos, done);
425 /* Update the current position */
432 ide_pad_transfer(drive, write, bcount);
434 debug_log("[cmd %x] transferred %d bytes, padded %d bytes\n",
435 rq->cmd[0], done, bcount);
437 /* And set the interrupt handler again */
438 ide_set_handler(drive, ide_pc_intr, timeout);
442 static void ide_init_packet_cmd(struct ide_cmd *cmd, u32 tf_flags,
445 cmd->protocol = dma ? ATAPI_PROT_DMA : ATAPI_PROT_PIO;
446 cmd->tf_flags |= IDE_TFLAG_OUT_LBAH | IDE_TFLAG_OUT_LBAM |
447 IDE_TFLAG_OUT_FEATURE | tf_flags;
448 cmd->tf.command = ATA_CMD_PACKET;
449 cmd->tf.feature = dma; /* Use PIO/DMA */
450 cmd->tf.lbam = bcount & 0xff;
451 cmd->tf.lbah = (bcount >> 8) & 0xff;
454 static u8 ide_read_ireason(ide_drive_t *drive)
458 memset(&cmd, 0, sizeof(cmd));
459 cmd.tf_flags = IDE_TFLAG_IN_NSECT;
461 drive->hwif->tp_ops->tf_read(drive, &cmd);
463 return cmd.tf.nsect & 3;
466 static u8 ide_wait_ireason(ide_drive_t *drive, u8 ireason)
470 while (retries-- && ((ireason & ATAPI_COD) == 0 ||
471 (ireason & ATAPI_IO))) {
472 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
473 "a packet command, retrying\n", drive->name);
475 ireason = ide_read_ireason(drive);
477 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
478 "a packet command, ignoring\n",
480 ireason |= ATAPI_COD;
481 ireason &= ~ATAPI_IO;
488 static int ide_delayed_transfer_pc(ide_drive_t *drive)
490 /* Send the actual packet */
491 drive->hwif->tp_ops->output_data(drive, NULL, drive->pc->c, 12);
493 /* Timeout for the packet command */
494 return WAIT_FLOPPY_CMD;
497 static ide_startstop_t ide_transfer_pc(ide_drive_t *drive)
499 struct ide_atapi_pc *uninitialized_var(pc);
500 ide_hwif_t *hwif = drive->hwif;
501 struct request *rq = hwif->rq;
502 ide_expiry_t *expiry;
503 unsigned int timeout;
505 ide_startstop_t startstop;
508 if (ide_wait_stat(&startstop, drive, ATA_DRQ, ATA_BUSY, WAIT_READY)) {
509 printk(KERN_ERR "%s: Strange, packet command initiated yet "
510 "DRQ isn't asserted\n", drive->name);
514 if (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT) {
516 drive->waiting_for_dma = 1;
519 if (dev_is_idecd(drive)) {
520 /* ATAPI commands get padded out to 12 bytes minimum */
521 cmd_len = COMMAND_SIZE(rq->cmd[0]);
522 if (cmd_len < ATAPI_MIN_CDB_BYTES)
523 cmd_len = ATAPI_MIN_CDB_BYTES;
525 timeout = rq->timeout;
526 expiry = ide_cd_expiry;
530 cmd_len = ATAPI_MIN_CDB_BYTES;
533 * If necessary schedule the packet transfer to occur 'timeout'
534 * miliseconds later in ide_delayed_transfer_pc() after the
535 * device says it's ready for a packet.
537 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
538 timeout = drive->pc_delay;
539 expiry = &ide_delayed_transfer_pc;
541 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
546 ireason = ide_read_ireason(drive);
547 if (drive->media == ide_tape)
548 ireason = ide_wait_ireason(drive, ireason);
550 if ((ireason & ATAPI_COD) == 0 || (ireason & ATAPI_IO)) {
551 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
552 "a packet command\n", drive->name);
554 return ide_do_reset(drive);
558 hwif->expiry = expiry;
560 /* Set the interrupt routine */
561 ide_set_handler(drive,
562 (dev_is_idecd(drive) ? drive->irq_handler
566 /* Send the actual packet */
567 if ((drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) == 0)
568 hwif->tp_ops->output_data(drive, NULL, rq->cmd, cmd_len);
570 /* Begin DMA, if necessary */
571 if (dev_is_idecd(drive)) {
573 hwif->dma_ops->dma_start(drive);
575 if (pc->flags & PC_FLAG_DMA_OK) {
576 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
577 hwif->dma_ops->dma_start(drive);
584 ide_startstop_t ide_issue_pc(ide_drive_t *drive, struct ide_cmd *cmd)
586 struct ide_atapi_pc *pc;
587 ide_hwif_t *hwif = drive->hwif;
588 ide_expiry_t *expiry = NULL;
589 struct request *rq = hwif->rq;
590 unsigned int timeout;
593 u8 drq_int = !!(drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT);
595 if (dev_is_idecd(drive)) {
596 tf_flags = IDE_TFLAG_OUT_NSECT | IDE_TFLAG_OUT_LBAL;
597 bcount = ide_cd_get_xferlen(rq);
598 expiry = ide_cd_expiry;
599 timeout = ATAPI_WAIT_PC;
602 drive->dma = !ide_dma_prepare(drive, cmd);
606 /* We haven't transferred any data yet */
608 pc->cur_pos = pc->buf;
610 tf_flags = IDE_TFLAG_OUT_DEVICE;
611 bcount = ((drive->media == ide_tape) ?
613 min(pc->req_xfer, 63 * 1024));
615 if (pc->flags & PC_FLAG_DMA_ERROR) {
616 pc->flags &= ~PC_FLAG_DMA_ERROR;
620 if (pc->flags & PC_FLAG_DMA_OK)
621 drive->dma = !ide_dma_prepare(drive, cmd);
624 pc->flags &= ~PC_FLAG_DMA_OK;
626 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
630 ide_init_packet_cmd(cmd, tf_flags, bcount, drive->dma);
632 (void)do_rw_taskfile(drive, cmd);
636 drive->waiting_for_dma = 0;
637 hwif->expiry = expiry;
640 ide_execute_command(drive, cmd, ide_transfer_pc, timeout);
642 return drq_int ? ide_started : ide_transfer_pc(drive);
644 EXPORT_SYMBOL_GPL(ide_issue_pc);