5 #include <linux/kernel.h>
6 #include <linux/cdrom.h>
7 #include <linux/delay.h>
8 #include <linux/export.h>
10 #include <linux/scatterlist.h>
11 #include <linux/gfp.h>
13 #include <scsi/scsi.h>
15 #define DRV_NAME "ide-atapi"
16 #define PFX DRV_NAME ": "
19 #define debug_log(fmt, args...) \
20 printk(KERN_INFO "ide: " fmt, ## args)
22 #define debug_log(fmt, args...) do {} while (0)
25 #define ATAPI_MIN_CDB_BYTES 12
27 static inline int dev_is_idecd(ide_drive_t
*drive
)
29 return drive
->media
== ide_cdrom
|| drive
->media
== ide_optical
;
33 * Check whether we can support a device,
34 * based on the ATAPI IDENTIFY command results.
36 int ide_check_atapi_device(ide_drive_t
*drive
, const char *s
)
39 u8 gcw
[2], protocol
, device_type
, removable
, drq_type
, packet_size
;
41 *((u16
*)&gcw
) = id
[ATA_ID_CONFIG
];
43 protocol
= (gcw
[1] & 0xC0) >> 6;
44 device_type
= gcw
[1] & 0x1F;
45 removable
= (gcw
[0] & 0x80) >> 7;
46 drq_type
= (gcw
[0] & 0x60) >> 5;
47 packet_size
= gcw
[0] & 0x03;
50 /* kludge for Apple PowerBook internal zip */
51 if (drive
->media
== ide_floppy
&& device_type
== 5 &&
52 !strstr((char *)&id
[ATA_ID_PROD
], "CD-ROM") &&
53 strstr((char *)&id
[ATA_ID_PROD
], "ZIP"))
58 printk(KERN_ERR
"%s: %s: protocol (0x%02x) is not ATAPI\n",
59 s
, drive
->name
, protocol
);
60 else if ((drive
->media
== ide_floppy
&& device_type
!= 0) ||
61 (drive
->media
== ide_tape
&& device_type
!= 1))
62 printk(KERN_ERR
"%s: %s: invalid device type (0x%02x)\n",
63 s
, drive
->name
, device_type
);
64 else if (removable
== 0)
65 printk(KERN_ERR
"%s: %s: the removable flag is not set\n",
67 else if (drive
->media
== ide_floppy
&& drq_type
== 3)
68 printk(KERN_ERR
"%s: %s: sorry, DRQ type (0x%02x) not "
69 "supported\n", s
, drive
->name
, drq_type
);
70 else if (packet_size
!= 0)
71 printk(KERN_ERR
"%s: %s: packet size (0x%02x) is not 12 "
72 "bytes\n", s
, drive
->name
, packet_size
);
77 EXPORT_SYMBOL_GPL(ide_check_atapi_device
);
79 void ide_init_pc(struct ide_atapi_pc
*pc
)
81 memset(pc
, 0, sizeof(*pc
));
83 EXPORT_SYMBOL_GPL(ide_init_pc
);
86 * Add a special packet command request to the tail of the request queue,
87 * and wait for it to be serviced.
89 int ide_queue_pc_tail(ide_drive_t
*drive
, struct gendisk
*disk
,
90 struct ide_atapi_pc
*pc
, void *buf
, unsigned int bufflen
)
95 rq
= blk_get_request(drive
->queue
, REQ_OP_DRV_IN
, __GFP_RECLAIM
);
96 ide_req(rq
)->type
= ATA_PRIV_MISC
;
97 rq
->special
= (char *)pc
;
100 error
= blk_rq_map_kern(drive
->queue
, rq
, buf
, bufflen
,
106 memcpy(scsi_req(rq
)->cmd
, pc
->c
, 12);
107 if (drive
->media
== ide_tape
)
108 scsi_req(rq
)->cmd
[13] = REQ_IDETAPE_PC1
;
109 blk_execute_rq(drive
->queue
, disk
, rq
, 0);
110 error
= scsi_req(rq
)->result
? -EIO
: 0;
115 EXPORT_SYMBOL_GPL(ide_queue_pc_tail
);
117 int ide_do_test_unit_ready(ide_drive_t
*drive
, struct gendisk
*disk
)
119 struct ide_atapi_pc pc
;
122 pc
.c
[0] = TEST_UNIT_READY
;
124 return ide_queue_pc_tail(drive
, disk
, &pc
, NULL
, 0);
126 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready
);
128 int ide_do_start_stop(ide_drive_t
*drive
, struct gendisk
*disk
, int start
)
130 struct ide_atapi_pc pc
;
133 pc
.c
[0] = START_STOP
;
136 if (drive
->media
== ide_tape
)
137 pc
.flags
|= PC_FLAG_WAIT_FOR_DSC
;
139 return ide_queue_pc_tail(drive
, disk
, &pc
, NULL
, 0);
141 EXPORT_SYMBOL_GPL(ide_do_start_stop
);
143 int ide_set_media_lock(ide_drive_t
*drive
, struct gendisk
*disk
, int on
)
145 struct ide_atapi_pc pc
;
147 if ((drive
->dev_flags
& IDE_DFLAG_DOORLOCKING
) == 0)
151 pc
.c
[0] = ALLOW_MEDIUM_REMOVAL
;
154 return ide_queue_pc_tail(drive
, disk
, &pc
, NULL
, 0);
156 EXPORT_SYMBOL_GPL(ide_set_media_lock
);
158 void ide_create_request_sense_cmd(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
)
161 pc
->c
[0] = REQUEST_SENSE
;
162 if (drive
->media
== ide_floppy
) {
170 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd
);
172 void ide_prep_sense(ide_drive_t
*drive
, struct request
*rq
)
174 struct request_sense
*sense
= &drive
->sense_data
;
175 struct request
*sense_rq
= drive
->sense_rq
;
176 struct scsi_request
*req
= scsi_req(sense_rq
);
177 unsigned int cmd_len
, sense_len
;
180 switch (drive
->media
) {
194 BUG_ON(sense_len
> sizeof(*sense
));
196 if (ata_sense_request(rq
) || drive
->sense_rq_armed
)
199 memset(sense
, 0, sizeof(*sense
));
201 blk_rq_init(rq
->q
, sense_rq
);
204 err
= blk_rq_map_kern(drive
->queue
, sense_rq
, sense
, sense_len
,
207 if (printk_ratelimit())
208 printk(KERN_WARNING PFX
"%s: failed to map sense "
209 "buffer\n", drive
->name
);
213 sense_rq
->rq_disk
= rq
->rq_disk
;
214 sense_rq
->cmd_flags
= REQ_OP_DRV_IN
;
215 ide_req(sense_rq
)->type
= ATA_PRIV_SENSE
;
216 sense_rq
->rq_flags
|= RQF_PREEMPT
;
218 req
->cmd
[0] = GPCMD_REQUEST_SENSE
;
219 req
->cmd
[4] = cmd_len
;
220 if (drive
->media
== ide_tape
)
221 req
->cmd
[13] = REQ_IDETAPE_PC1
;
223 drive
->sense_rq_armed
= true;
225 EXPORT_SYMBOL_GPL(ide_prep_sense
);
227 int ide_queue_sense_rq(ide_drive_t
*drive
, void *special
)
229 /* deferred failure from ide_prep_sense() */
230 if (!drive
->sense_rq_armed
) {
231 printk(KERN_WARNING PFX
"%s: error queuing a sense request\n",
236 drive
->sense_rq
->special
= special
;
237 drive
->sense_rq_armed
= false;
239 drive
->hwif
->rq
= NULL
;
241 elv_add_request(drive
->queue
, drive
->sense_rq
, ELEVATOR_INSERT_FRONT
);
244 EXPORT_SYMBOL_GPL(ide_queue_sense_rq
);
247 * Called when an error was detected during the last packet command.
248 * We queue a request sense packet command at the head of the request
251 void ide_retry_pc(ide_drive_t
*drive
)
253 struct request
*failed_rq
= drive
->hwif
->rq
;
254 struct request
*sense_rq
= drive
->sense_rq
;
255 struct ide_atapi_pc
*pc
= &drive
->request_sense_pc
;
257 (void)ide_read_error(drive
);
259 /* init pc from sense_rq */
261 memcpy(pc
->c
, scsi_req(sense_rq
)->cmd
, 12);
263 if (drive
->media
== ide_tape
)
264 drive
->atapi_flags
|= IDE_AFLAG_IGNORE_DSC
;
267 * Push back the failed request and put request sense on top
268 * of it. The failed command will be retried after sense data
271 drive
->hwif
->rq
= NULL
;
272 ide_requeue_and_plug(drive
, failed_rq
);
273 if (ide_queue_sense_rq(drive
, pc
)) {
274 blk_start_request(failed_rq
);
275 ide_complete_rq(drive
, BLK_STS_IOERR
, blk_rq_bytes(failed_rq
));
278 EXPORT_SYMBOL_GPL(ide_retry_pc
);
280 int ide_cd_expiry(ide_drive_t
*drive
)
282 struct request
*rq
= drive
->hwif
->rq
;
283 unsigned long wait
= 0;
285 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__
, rq
->cmd
[0]);
288 * Some commands are *slow* and normally take a long time to complete.
289 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
290 * commands/drives support that. Let ide_timer_expiry keep polling us
293 switch (scsi_req(rq
)->cmd
[0]) {
295 case GPCMD_FORMAT_UNIT
:
296 case GPCMD_RESERVE_RZONE_TRACK
:
297 case GPCMD_CLOSE_TRACK
:
298 case GPCMD_FLUSH_CACHE
:
299 wait
= ATAPI_WAIT_PC
;
302 if (!(rq
->rq_flags
& RQF_QUIET
))
303 printk(KERN_INFO PFX
"cmd 0x%x timed out\n",
304 scsi_req(rq
)->cmd
[0]);
310 EXPORT_SYMBOL_GPL(ide_cd_expiry
);
312 int ide_cd_get_xferlen(struct request
*rq
)
314 switch (req_op(rq
)) {
318 case REQ_OP_SCSI_OUT
:
319 return blk_rq_bytes(rq
);
322 switch (ide_req(rq
)->type
) {
325 return blk_rq_bytes(rq
);
331 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen
);
333 void ide_read_bcount_and_ireason(ide_drive_t
*drive
, u16
*bcount
, u8
*ireason
)
335 struct ide_taskfile tf
;
337 drive
->hwif
->tp_ops
->tf_read(drive
, &tf
, IDE_VALID_NSECT
|
338 IDE_VALID_LBAM
| IDE_VALID_LBAH
);
340 *bcount
= (tf
.lbah
<< 8) | tf
.lbam
;
341 *ireason
= tf
.nsect
& 3;
343 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason
);
346 * Check the contents of the interrupt reason register and attempt to recover if
347 * there are problems.
350 * - 0 if everything's ok
351 * - 1 if the request has to be terminated.
353 int ide_check_ireason(ide_drive_t
*drive
, struct request
*rq
, int len
,
356 ide_hwif_t
*hwif
= drive
->hwif
;
358 debug_log("ireason: 0x%x, rw: 0x%x\n", ireason
, rw
);
360 if (ireason
== (!rw
<< 1))
362 else if (ireason
== (rw
<< 1)) {
363 printk(KERN_ERR PFX
"%s: %s: wrong transfer direction!\n",
364 drive
->name
, __func__
);
366 if (dev_is_idecd(drive
))
367 ide_pad_transfer(drive
, rw
, len
);
368 } else if (!rw
&& ireason
== ATAPI_COD
) {
369 if (dev_is_idecd(drive
)) {
371 * Some drives (ASUS) seem to tell us that status info
372 * is available. Just get it and ignore.
374 (void)hwif
->tp_ops
->read_status(hwif
);
378 if (ireason
& ATAPI_COD
)
379 printk(KERN_ERR PFX
"%s: CoD != 0 in %s\n", drive
->name
,
382 /* drive wants a command packet, or invalid ireason... */
383 printk(KERN_ERR PFX
"%s: %s: bad interrupt reason 0x%02x\n",
384 drive
->name
, __func__
, ireason
);
387 if (dev_is_idecd(drive
) && ata_pc_request(rq
))
388 rq
->rq_flags
|= RQF_FAILED
;
392 EXPORT_SYMBOL_GPL(ide_check_ireason
);
395 * This is the usual interrupt handler which will be called during a packet
396 * command. We will transfer some of the data (as requested by the drive)
397 * and will re-point interrupt handler to us.
399 static ide_startstop_t
ide_pc_intr(ide_drive_t
*drive
)
401 struct ide_atapi_pc
*pc
= drive
->pc
;
402 ide_hwif_t
*hwif
= drive
->hwif
;
403 struct ide_cmd
*cmd
= &hwif
->cmd
;
404 struct request
*rq
= hwif
->rq
;
405 const struct ide_tp_ops
*tp_ops
= hwif
->tp_ops
;
406 unsigned int timeout
, done
;
408 u8 stat
, ireason
, dsc
= 0;
409 u8 write
= !!(pc
->flags
& PC_FLAG_WRITING
);
411 debug_log("Enter %s - interrupt handler\n", __func__
);
413 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
416 /* Clear the interrupt */
417 stat
= tp_ops
->read_status(hwif
);
419 if (pc
->flags
& PC_FLAG_DMA_IN_PROGRESS
) {
422 drive
->waiting_for_dma
= 0;
423 rc
= hwif
->dma_ops
->dma_end(drive
);
424 ide_dma_unmap_sg(drive
, cmd
);
426 if (rc
|| (drive
->media
== ide_tape
&& (stat
& ATA_ERR
))) {
427 if (drive
->media
== ide_floppy
)
428 printk(KERN_ERR PFX
"%s: DMA %s error\n",
429 drive
->name
, rq_data_dir(pc
->rq
)
431 pc
->flags
|= PC_FLAG_DMA_ERROR
;
433 scsi_req(rq
)->resid_len
= 0;
434 debug_log("%s: DMA finished\n", drive
->name
);
437 /* No more interrupts */
438 if ((stat
& ATA_DRQ
) == 0) {
442 debug_log("Packet command completed, %d bytes transferred\n",
445 pc
->flags
&= ~PC_FLAG_DMA_IN_PROGRESS
;
447 local_irq_enable_in_hardirq();
449 if (drive
->media
== ide_tape
&&
450 (stat
& ATA_ERR
) && scsi_req(rq
)->cmd
[0] == REQUEST_SENSE
)
453 if ((stat
& ATA_ERR
) || (pc
->flags
& PC_FLAG_DMA_ERROR
)) {
455 debug_log("%s: I/O error\n", drive
->name
);
457 if (drive
->media
!= ide_tape
)
458 scsi_req(pc
->rq
)->result
++;
460 if (scsi_req(rq
)->cmd
[0] == REQUEST_SENSE
) {
461 printk(KERN_ERR PFX
"%s: I/O error in request "
462 "sense command\n", drive
->name
);
463 return ide_do_reset(drive
);
466 debug_log("[cmd %x]: check condition\n", rq
->cmd
[0]);
468 /* Retry operation */
471 /* queued, but not started */
476 if ((pc
->flags
& PC_FLAG_WAIT_FOR_DSC
) && (stat
& ATA_DSC
) == 0)
480 * ->pc_callback() might change rq->data_len for
481 * residual count, cache total length.
483 done
= blk_rq_bytes(rq
);
485 /* Command finished - Call the callback function */
486 uptodate
= drive
->pc_callback(drive
, dsc
);
489 drive
->failed_pc
= NULL
;
491 if (ata_misc_request(rq
)) {
492 scsi_req(rq
)->result
= 0;
496 if (blk_rq_is_passthrough(rq
) && uptodate
<= 0) {
497 if (scsi_req(rq
)->result
== 0)
498 scsi_req(rq
)->result
= -EIO
;
501 error
= uptodate
? BLK_STS_OK
: BLK_STS_IOERR
;
504 ide_complete_rq(drive
, error
, blk_rq_bytes(rq
));
508 if (pc
->flags
& PC_FLAG_DMA_IN_PROGRESS
) {
509 pc
->flags
&= ~PC_FLAG_DMA_IN_PROGRESS
;
510 printk(KERN_ERR PFX
"%s: The device wants to issue more "
511 "interrupts in DMA mode\n", drive
->name
);
513 return ide_do_reset(drive
);
516 /* Get the number of bytes to transfer on this interrupt. */
517 ide_read_bcount_and_ireason(drive
, &bcount
, &ireason
);
519 if (ide_check_ireason(drive
, rq
, bcount
, ireason
, write
))
520 return ide_do_reset(drive
);
522 done
= min_t(unsigned int, bcount
, cmd
->nleft
);
523 ide_pio_bytes(drive
, cmd
, write
, done
);
525 /* Update transferred byte count */
526 scsi_req(rq
)->resid_len
-= done
;
531 ide_pad_transfer(drive
, write
, bcount
);
533 debug_log("[cmd %x] transferred %d bytes, padded %d bytes, resid: %u\n",
534 rq
->cmd
[0], done
, bcount
, scsi_req(rq
)->resid_len
);
536 /* And set the interrupt handler again */
537 ide_set_handler(drive
, ide_pc_intr
, timeout
);
541 static void ide_init_packet_cmd(struct ide_cmd
*cmd
, u8 valid_tf
,
544 cmd
->protocol
= dma
? ATAPI_PROT_DMA
: ATAPI_PROT_PIO
;
545 cmd
->valid
.out
.tf
= IDE_VALID_LBAH
| IDE_VALID_LBAM
|
546 IDE_VALID_FEATURE
| valid_tf
;
547 cmd
->tf
.command
= ATA_CMD_PACKET
;
548 cmd
->tf
.feature
= dma
; /* Use PIO/DMA */
549 cmd
->tf
.lbam
= bcount
& 0xff;
550 cmd
->tf
.lbah
= (bcount
>> 8) & 0xff;
553 static u8
ide_read_ireason(ide_drive_t
*drive
)
555 struct ide_taskfile tf
;
557 drive
->hwif
->tp_ops
->tf_read(drive
, &tf
, IDE_VALID_NSECT
);
562 static u8
ide_wait_ireason(ide_drive_t
*drive
, u8 ireason
)
566 while (retries
-- && ((ireason
& ATAPI_COD
) == 0 ||
567 (ireason
& ATAPI_IO
))) {
568 printk(KERN_ERR PFX
"%s: (IO,CoD != (0,1) while issuing "
569 "a packet command, retrying\n", drive
->name
);
571 ireason
= ide_read_ireason(drive
);
573 printk(KERN_ERR PFX
"%s: (IO,CoD != (0,1) while issuing"
574 " a packet command, ignoring\n",
576 ireason
|= ATAPI_COD
;
577 ireason
&= ~ATAPI_IO
;
584 static int ide_delayed_transfer_pc(ide_drive_t
*drive
)
586 /* Send the actual packet */
587 drive
->hwif
->tp_ops
->output_data(drive
, NULL
, drive
->pc
->c
, 12);
589 /* Timeout for the packet command */
590 return WAIT_FLOPPY_CMD
;
593 static ide_startstop_t
ide_transfer_pc(ide_drive_t
*drive
)
595 struct ide_atapi_pc
*uninitialized_var(pc
);
596 ide_hwif_t
*hwif
= drive
->hwif
;
597 struct request
*rq
= hwif
->rq
;
598 ide_expiry_t
*expiry
;
599 unsigned int timeout
;
601 ide_startstop_t startstop
;
604 if (ide_wait_stat(&startstop
, drive
, ATA_DRQ
, ATA_BUSY
, WAIT_READY
)) {
605 printk(KERN_ERR PFX
"%s: Strange, packet command initiated yet "
606 "DRQ isn't asserted\n", drive
->name
);
610 if (drive
->atapi_flags
& IDE_AFLAG_DRQ_INTERRUPT
) {
612 drive
->waiting_for_dma
= 1;
615 if (dev_is_idecd(drive
)) {
616 /* ATAPI commands get padded out to 12 bytes minimum */
617 cmd_len
= COMMAND_SIZE(scsi_req(rq
)->cmd
[0]);
618 if (cmd_len
< ATAPI_MIN_CDB_BYTES
)
619 cmd_len
= ATAPI_MIN_CDB_BYTES
;
621 timeout
= rq
->timeout
;
622 expiry
= ide_cd_expiry
;
626 cmd_len
= ATAPI_MIN_CDB_BYTES
;
629 * If necessary schedule the packet transfer to occur 'timeout'
630 * milliseconds later in ide_delayed_transfer_pc() after the
631 * device says it's ready for a packet.
633 if (drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) {
634 timeout
= drive
->pc_delay
;
635 expiry
= &ide_delayed_transfer_pc
;
637 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
642 ireason
= ide_read_ireason(drive
);
643 if (drive
->media
== ide_tape
)
644 ireason
= ide_wait_ireason(drive
, ireason
);
646 if ((ireason
& ATAPI_COD
) == 0 || (ireason
& ATAPI_IO
)) {
647 printk(KERN_ERR PFX
"%s: (IO,CoD) != (0,1) while "
648 "issuing a packet command\n", drive
->name
);
650 return ide_do_reset(drive
);
654 hwif
->expiry
= expiry
;
656 /* Set the interrupt routine */
657 ide_set_handler(drive
,
658 (dev_is_idecd(drive
) ? drive
->irq_handler
662 /* Send the actual packet */
663 if ((drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) == 0)
664 hwif
->tp_ops
->output_data(drive
, NULL
, scsi_req(rq
)->cmd
, cmd_len
);
666 /* Begin DMA, if necessary */
667 if (dev_is_idecd(drive
)) {
669 hwif
->dma_ops
->dma_start(drive
);
671 if (pc
->flags
& PC_FLAG_DMA_OK
) {
672 pc
->flags
|= PC_FLAG_DMA_IN_PROGRESS
;
673 hwif
->dma_ops
->dma_start(drive
);
680 ide_startstop_t
ide_issue_pc(ide_drive_t
*drive
, struct ide_cmd
*cmd
)
682 struct ide_atapi_pc
*pc
;
683 ide_hwif_t
*hwif
= drive
->hwif
;
684 ide_expiry_t
*expiry
= NULL
;
685 struct request
*rq
= hwif
->rq
;
686 unsigned int timeout
, bytes
;
689 u8 drq_int
= !!(drive
->atapi_flags
& IDE_AFLAG_DRQ_INTERRUPT
);
691 if (dev_is_idecd(drive
)) {
692 valid_tf
= IDE_VALID_NSECT
| IDE_VALID_LBAL
;
693 bcount
= ide_cd_get_xferlen(rq
);
694 expiry
= ide_cd_expiry
;
695 timeout
= ATAPI_WAIT_PC
;
698 drive
->dma
= !ide_dma_prepare(drive
, cmd
);
702 valid_tf
= IDE_VALID_DEVICE
;
703 bytes
= blk_rq_bytes(rq
);
704 bcount
= ((drive
->media
== ide_tape
) ? bytes
705 : min_t(unsigned int,
708 /* We haven't transferred any data yet */
709 scsi_req(rq
)->resid_len
= bcount
;
711 if (pc
->flags
& PC_FLAG_DMA_ERROR
) {
712 pc
->flags
&= ~PC_FLAG_DMA_ERROR
;
716 if (pc
->flags
& PC_FLAG_DMA_OK
)
717 drive
->dma
= !ide_dma_prepare(drive
, cmd
);
720 pc
->flags
&= ~PC_FLAG_DMA_OK
;
722 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
726 ide_init_packet_cmd(cmd
, valid_tf
, bcount
, drive
->dma
);
728 (void)do_rw_taskfile(drive
, cmd
);
732 drive
->waiting_for_dma
= 0;
733 hwif
->expiry
= expiry
;
736 ide_execute_command(drive
, cmd
, ide_transfer_pc
, timeout
);
738 return drq_int
? ide_started
: ide_transfer_pc(drive
);
740 EXPORT_SYMBOL_GPL(ide_issue_pc
);