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);
115 EXPORT_SYMBOL_GPL(ide_io_buffers);
117 void ide_init_pc(struct ide_atapi_pc *pc)
119 memset(pc, 0, sizeof(*pc));
120 pc->buf = pc->pc_buf;
121 pc->buf_size = IDE_PC_BUFFER_SIZE;
123 EXPORT_SYMBOL_GPL(ide_init_pc);
126 * Generate a new packet command request in front of the request queue, before
127 * the current request, so that it will be processed immediately, on the next
128 * pass through the driver.
130 static void ide_queue_pc_head(ide_drive_t *drive, struct gendisk *disk,
131 struct ide_atapi_pc *pc, struct request *rq)
133 blk_rq_init(NULL, rq);
134 rq->cmd_type = REQ_TYPE_SPECIAL;
135 rq->cmd_flags |= REQ_PREEMPT;
136 rq->buffer = (char *)pc;
141 rq->data_len = pc->req_xfer;
144 memcpy(rq->cmd, pc->c, 12);
145 if (drive->media == ide_tape)
146 rq->cmd[13] = REQ_IDETAPE_PC1;
148 drive->hwif->rq = NULL;
150 elv_add_request(drive->queue, rq, ELEVATOR_INSERT_FRONT, 0);
154 * Add a special packet command request to the tail of the request queue,
155 * and wait for it to be serviced.
157 int ide_queue_pc_tail(ide_drive_t *drive, struct gendisk *disk,
158 struct ide_atapi_pc *pc)
163 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
164 rq->cmd_type = REQ_TYPE_SPECIAL;
165 rq->buffer = (char *)pc;
169 rq->data_len = pc->req_xfer;
172 memcpy(rq->cmd, pc->c, 12);
173 if (drive->media == ide_tape)
174 rq->cmd[13] = REQ_IDETAPE_PC1;
175 error = blk_execute_rq(drive->queue, disk, rq, 0);
180 EXPORT_SYMBOL_GPL(ide_queue_pc_tail);
182 int ide_do_test_unit_ready(ide_drive_t *drive, struct gendisk *disk)
184 struct ide_atapi_pc pc;
187 pc.c[0] = TEST_UNIT_READY;
189 return ide_queue_pc_tail(drive, disk, &pc);
191 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready);
193 int ide_do_start_stop(ide_drive_t *drive, struct gendisk *disk, int start)
195 struct ide_atapi_pc pc;
198 pc.c[0] = START_STOP;
201 if (drive->media == ide_tape)
202 pc.flags |= PC_FLAG_WAIT_FOR_DSC;
204 return ide_queue_pc_tail(drive, disk, &pc);
206 EXPORT_SYMBOL_GPL(ide_do_start_stop);
208 int ide_set_media_lock(ide_drive_t *drive, struct gendisk *disk, int on)
210 struct ide_atapi_pc pc;
212 if ((drive->dev_flags & IDE_DFLAG_DOORLOCKING) == 0)
216 pc.c[0] = ALLOW_MEDIUM_REMOVAL;
219 return ide_queue_pc_tail(drive, disk, &pc);
221 EXPORT_SYMBOL_GPL(ide_set_media_lock);
223 void ide_create_request_sense_cmd(ide_drive_t *drive, struct ide_atapi_pc *pc)
226 pc->c[0] = REQUEST_SENSE;
227 if (drive->media == ide_floppy) {
235 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd);
238 * Called when an error was detected during the last packet command.
239 * We queue a request sense packet command in the head of the request list.
241 void ide_retry_pc(ide_drive_t *drive, struct gendisk *disk)
243 struct request *rq = &drive->request_sense_rq;
244 struct ide_atapi_pc *pc = &drive->request_sense_pc;
246 (void)ide_read_error(drive);
247 ide_create_request_sense_cmd(drive, pc);
248 if (drive->media == ide_tape)
249 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
250 ide_queue_pc_head(drive, disk, pc, rq);
252 EXPORT_SYMBOL_GPL(ide_retry_pc);
254 int ide_cd_expiry(ide_drive_t *drive)
256 struct request *rq = drive->hwif->rq;
257 unsigned long wait = 0;
259 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__, rq->cmd[0]);
262 * Some commands are *slow* and normally take a long time to complete.
263 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
264 * commands/drives support that. Let ide_timer_expiry keep polling us
267 switch (rq->cmd[0]) {
269 case GPCMD_FORMAT_UNIT:
270 case GPCMD_RESERVE_RZONE_TRACK:
271 case GPCMD_CLOSE_TRACK:
272 case GPCMD_FLUSH_CACHE:
273 wait = ATAPI_WAIT_PC;
276 if (!(rq->cmd_flags & REQ_QUIET))
277 printk(KERN_INFO "cmd 0x%x timed out\n",
284 EXPORT_SYMBOL_GPL(ide_cd_expiry);
286 int ide_cd_get_xferlen(struct request *rq)
288 if (blk_fs_request(rq))
290 else if (blk_sense_request(rq) || blk_pc_request(rq) ||
291 rq->cmd_type == REQ_TYPE_ATA_PC)
296 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen);
298 void ide_read_bcount_and_ireason(ide_drive_t *drive, u16 *bcount, u8 *ireason)
302 memset(&cmd, 0, sizeof(cmd));
303 cmd.tf_flags = IDE_TFLAG_IN_LBAH | IDE_TFLAG_IN_LBAM |
306 drive->hwif->tp_ops->tf_read(drive, &cmd);
308 *bcount = (cmd.tf.lbah << 8) | cmd.tf.lbam;
309 *ireason = cmd.tf.nsect & 3;
311 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason);
314 * This is the usual interrupt handler which will be called during a packet
315 * command. We will transfer some of the data (as requested by the drive)
316 * and will re-point interrupt handler to us.
318 static ide_startstop_t ide_pc_intr(ide_drive_t *drive)
320 struct ide_atapi_pc *pc = drive->pc;
321 ide_hwif_t *hwif = drive->hwif;
322 struct ide_cmd *cmd = &hwif->cmd;
323 struct request *rq = hwif->rq;
324 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
325 xfer_func_t *xferfunc;
326 unsigned int timeout, done;
328 u8 stat, ireason, dsc = 0;
329 u8 write = !!(pc->flags & PC_FLAG_WRITING);
331 debug_log("Enter %s - interrupt handler\n", __func__);
333 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
336 /* Clear the interrupt */
337 stat = tp_ops->read_status(hwif);
339 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
342 drive->waiting_for_dma = 0;
343 rc = hwif->dma_ops->dma_end(drive);
344 ide_dma_unmap_sg(drive, cmd);
346 if (rc || (drive->media == ide_tape && (stat & ATA_ERR))) {
347 if (drive->media == ide_floppy)
348 printk(KERN_ERR "%s: DMA %s error\n",
349 drive->name, rq_data_dir(pc->rq)
351 pc->flags |= PC_FLAG_DMA_ERROR;
353 pc->xferred = pc->req_xfer;
354 if (drive->pc_update_buffers)
355 drive->pc_update_buffers(drive, pc);
357 debug_log("%s: DMA finished\n", drive->name);
360 /* No more interrupts */
361 if ((stat & ATA_DRQ) == 0) {
364 debug_log("Packet command completed, %d bytes transferred\n",
367 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
369 local_irq_enable_in_hardirq();
371 if (drive->media == ide_tape &&
372 (stat & ATA_ERR) && rq->cmd[0] == REQUEST_SENSE)
375 if ((stat & ATA_ERR) || (pc->flags & PC_FLAG_DMA_ERROR)) {
377 debug_log("%s: I/O error\n", drive->name);
379 if (drive->media != ide_tape)
382 if (rq->cmd[0] == REQUEST_SENSE) {
383 printk(KERN_ERR "%s: I/O error in request sense"
384 " command\n", drive->name);
385 return ide_do_reset(drive);
388 debug_log("[cmd %x]: check condition\n", rq->cmd[0]);
390 /* Retry operation */
391 ide_retry_pc(drive, rq->rq_disk);
393 /* queued, but not started */
398 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) && (stat & ATA_DSC) == 0)
401 /* Command finished - Call the callback function */
402 uptodate = drive->pc_callback(drive, dsc);
405 drive->failed_pc = NULL;
407 if (blk_special_request(rq)) {
409 ide_complete_rq(drive, 0, blk_rq_bytes(rq));
411 if (blk_fs_request(rq) == 0 && uptodate <= 0) {
415 ide_complete_rq(drive, uptodate ? 0 : -EIO,
422 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
423 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
424 printk(KERN_ERR "%s: The device wants to issue more interrupts "
425 "in DMA mode\n", drive->name);
427 return ide_do_reset(drive);
430 /* Get the number of bytes to transfer on this interrupt. */
431 ide_read_bcount_and_ireason(drive, &bcount, &ireason);
433 if (ireason & ATAPI_COD) {
434 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
435 return ide_do_reset(drive);
438 if (((ireason & ATAPI_IO) == ATAPI_IO) == write) {
439 /* Hopefully, we will never get here */
440 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
441 "to %s!\n", drive->name,
442 (ireason & ATAPI_IO) ? "Write" : "Read",
443 (ireason & ATAPI_IO) ? "Read" : "Write");
444 return ide_do_reset(drive);
447 xferfunc = write ? tp_ops->output_data : tp_ops->input_data;
449 if ((drive->media == ide_floppy && !pc->buf) ||
450 (drive->media == ide_tape && pc->bh)) {
451 done = drive->pc_io_buffers(drive, pc, bcount, write);
453 /* FIXME: don't do partial completions */
454 if (drive->media == ide_floppy)
455 ide_complete_rq(drive, 0,
456 done ? done : ide_rq_bytes(rq));
458 done = min_t(unsigned int, bcount, pc->req_xfer - pc->xferred);
459 xferfunc(drive, NULL, pc->cur_pos, done);
462 /* Update the current position */
469 ide_pad_transfer(drive, write, bcount);
471 debug_log("[cmd %x] transferred %d bytes, padded %d bytes\n",
472 rq->cmd[0], done, bcount);
474 /* And set the interrupt handler again */
475 ide_set_handler(drive, ide_pc_intr, timeout);
479 static void ide_init_packet_cmd(struct ide_cmd *cmd, u32 tf_flags,
482 cmd->protocol = dma ? ATAPI_PROT_DMA : ATAPI_PROT_PIO;
483 cmd->tf_flags |= IDE_TFLAG_OUT_LBAH | IDE_TFLAG_OUT_LBAM |
484 IDE_TFLAG_OUT_FEATURE | tf_flags;
485 cmd->tf.command = ATA_CMD_PACKET;
486 cmd->tf.feature = dma; /* Use PIO/DMA */
487 cmd->tf.lbam = bcount & 0xff;
488 cmd->tf.lbah = (bcount >> 8) & 0xff;
491 static u8 ide_read_ireason(ide_drive_t *drive)
495 memset(&cmd, 0, sizeof(cmd));
496 cmd.tf_flags = IDE_TFLAG_IN_NSECT;
498 drive->hwif->tp_ops->tf_read(drive, &cmd);
500 return cmd.tf.nsect & 3;
503 static u8 ide_wait_ireason(ide_drive_t *drive, u8 ireason)
507 while (retries-- && ((ireason & ATAPI_COD) == 0 ||
508 (ireason & ATAPI_IO))) {
509 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
510 "a packet command, retrying\n", drive->name);
512 ireason = ide_read_ireason(drive);
514 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
515 "a packet command, ignoring\n",
517 ireason |= ATAPI_COD;
518 ireason &= ~ATAPI_IO;
525 static int ide_delayed_transfer_pc(ide_drive_t *drive)
527 /* Send the actual packet */
528 drive->hwif->tp_ops->output_data(drive, NULL, drive->pc->c, 12);
530 /* Timeout for the packet command */
531 return WAIT_FLOPPY_CMD;
534 static ide_startstop_t ide_transfer_pc(ide_drive_t *drive)
536 struct ide_atapi_pc *uninitialized_var(pc);
537 ide_hwif_t *hwif = drive->hwif;
538 struct request *rq = hwif->rq;
539 ide_expiry_t *expiry;
540 unsigned int timeout;
542 ide_startstop_t startstop;
545 if (ide_wait_stat(&startstop, drive, ATA_DRQ, ATA_BUSY, WAIT_READY)) {
546 printk(KERN_ERR "%s: Strange, packet command initiated yet "
547 "DRQ isn't asserted\n", drive->name);
551 if (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT) {
553 drive->waiting_for_dma = 1;
556 if (dev_is_idecd(drive)) {
557 /* ATAPI commands get padded out to 12 bytes minimum */
558 cmd_len = COMMAND_SIZE(rq->cmd[0]);
559 if (cmd_len < ATAPI_MIN_CDB_BYTES)
560 cmd_len = ATAPI_MIN_CDB_BYTES;
562 timeout = rq->timeout;
563 expiry = ide_cd_expiry;
567 cmd_len = ATAPI_MIN_CDB_BYTES;
570 * If necessary schedule the packet transfer to occur 'timeout'
571 * miliseconds later in ide_delayed_transfer_pc() after the
572 * device says it's ready for a packet.
574 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
575 timeout = drive->pc_delay;
576 expiry = &ide_delayed_transfer_pc;
578 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
583 ireason = ide_read_ireason(drive);
584 if (drive->media == ide_tape)
585 ireason = ide_wait_ireason(drive, ireason);
587 if ((ireason & ATAPI_COD) == 0 || (ireason & ATAPI_IO)) {
588 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
589 "a packet command\n", drive->name);
591 return ide_do_reset(drive);
595 hwif->expiry = expiry;
597 /* Set the interrupt routine */
598 ide_set_handler(drive,
599 (dev_is_idecd(drive) ? drive->irq_handler
603 /* Send the actual packet */
604 if ((drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) == 0)
605 hwif->tp_ops->output_data(drive, NULL, rq->cmd, cmd_len);
607 /* Begin DMA, if necessary */
608 if (dev_is_idecd(drive)) {
610 hwif->dma_ops->dma_start(drive);
612 if (pc->flags & PC_FLAG_DMA_OK) {
613 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
614 hwif->dma_ops->dma_start(drive);
621 ide_startstop_t ide_issue_pc(ide_drive_t *drive, struct ide_cmd *cmd)
623 struct ide_atapi_pc *pc;
624 ide_hwif_t *hwif = drive->hwif;
625 ide_expiry_t *expiry = NULL;
626 struct request *rq = hwif->rq;
627 unsigned int timeout;
630 u8 drq_int = !!(drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT);
632 if (dev_is_idecd(drive)) {
633 tf_flags = IDE_TFLAG_OUT_NSECT | IDE_TFLAG_OUT_LBAL;
634 bcount = ide_cd_get_xferlen(rq);
635 expiry = ide_cd_expiry;
636 timeout = ATAPI_WAIT_PC;
639 drive->dma = !ide_dma_prepare(drive, cmd);
643 /* We haven't transferred any data yet */
645 pc->cur_pos = pc->buf;
647 tf_flags = IDE_TFLAG_OUT_DEVICE;
648 bcount = ((drive->media == ide_tape) ?
650 min(pc->req_xfer, 63 * 1024));
652 if (pc->flags & PC_FLAG_DMA_ERROR) {
653 pc->flags &= ~PC_FLAG_DMA_ERROR;
657 if (pc->flags & PC_FLAG_DMA_OK)
658 drive->dma = !ide_dma_prepare(drive, cmd);
661 pc->flags &= ~PC_FLAG_DMA_OK;
663 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
667 ide_init_packet_cmd(cmd, tf_flags, bcount, drive->dma);
669 (void)do_rw_taskfile(drive, cmd);
673 drive->waiting_for_dma = 0;
674 hwif->expiry = expiry;
677 ide_execute_command(drive, cmd, ide_transfer_pc, timeout);
679 return drq_int ? ide_started : ide_transfer_pc(drive);
681 EXPORT_SYMBOL_GPL(ide_issue_pc);