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
;
97 error
= blk_rq_map_kern(drive
->queue
, rq
, pc
->buf
, pc
->req_xfer
,
103 memcpy(rq
->cmd
, pc
->c
, 12);
104 if (drive
->media
== ide_tape
)
105 rq
->cmd
[13] = REQ_IDETAPE_PC1
;
106 error
= blk_execute_rq(drive
->queue
, disk
, rq
, 0);
111 EXPORT_SYMBOL_GPL(ide_queue_pc_tail
);
113 int ide_do_test_unit_ready(ide_drive_t
*drive
, struct gendisk
*disk
)
115 struct ide_atapi_pc pc
;
118 pc
.c
[0] = TEST_UNIT_READY
;
120 return ide_queue_pc_tail(drive
, disk
, &pc
);
122 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready
);
124 int ide_do_start_stop(ide_drive_t
*drive
, struct gendisk
*disk
, int start
)
126 struct ide_atapi_pc pc
;
129 pc
.c
[0] = START_STOP
;
132 if (drive
->media
== ide_tape
)
133 pc
.flags
|= PC_FLAG_WAIT_FOR_DSC
;
135 return ide_queue_pc_tail(drive
, disk
, &pc
);
137 EXPORT_SYMBOL_GPL(ide_do_start_stop
);
139 int ide_set_media_lock(ide_drive_t
*drive
, struct gendisk
*disk
, int on
)
141 struct ide_atapi_pc pc
;
143 if ((drive
->dev_flags
& IDE_DFLAG_DOORLOCKING
) == 0)
147 pc
.c
[0] = ALLOW_MEDIUM_REMOVAL
;
150 return ide_queue_pc_tail(drive
, disk
, &pc
);
152 EXPORT_SYMBOL_GPL(ide_set_media_lock
);
154 void ide_create_request_sense_cmd(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
)
157 pc
->c
[0] = REQUEST_SENSE
;
158 if (drive
->media
== ide_floppy
) {
166 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd
);
168 void ide_prep_sense(ide_drive_t
*drive
, struct request
*rq
)
170 struct request_sense
*sense
= &drive
->sense_data
;
171 struct request
*sense_rq
= &drive
->sense_rq
;
172 unsigned int cmd_len
, sense_len
;
175 debug_log("%s: enter\n", __func__
);
177 switch (drive
->media
) {
191 BUG_ON(sense_len
> sizeof(*sense
));
193 if (blk_sense_request(rq
) || drive
->sense_rq_armed
)
196 memset(sense
, 0, sizeof(*sense
));
198 blk_rq_init(rq
->q
, sense_rq
);
200 err
= blk_rq_map_kern(drive
->queue
, sense_rq
, sense
, sense_len
,
203 if (printk_ratelimit())
204 printk(KERN_WARNING
"%s: failed to map sense buffer\n",
209 sense_rq
->rq_disk
= rq
->rq_disk
;
210 sense_rq
->cmd
[0] = GPCMD_REQUEST_SENSE
;
211 sense_rq
->cmd
[4] = cmd_len
;
212 sense_rq
->cmd_type
= REQ_TYPE_SENSE
;
213 sense_rq
->cmd_flags
|= REQ_PREEMPT
;
215 if (drive
->media
== ide_tape
)
216 sense_rq
->cmd
[13] = REQ_IDETAPE_PC1
;
218 drive
->sense_rq_armed
= true;
220 EXPORT_SYMBOL_GPL(ide_prep_sense
);
222 int ide_queue_sense_rq(ide_drive_t
*drive
, void *special
)
224 /* deferred failure from ide_prep_sense() */
225 if (!drive
->sense_rq_armed
) {
226 printk(KERN_WARNING
"%s: failed queue sense request\n",
231 drive
->sense_rq
.special
= special
;
232 drive
->sense_rq_armed
= false;
234 drive
->hwif
->rq
= NULL
;
236 elv_add_request(drive
->queue
, &drive
->sense_rq
,
237 ELEVATOR_INSERT_FRONT
, 0);
240 EXPORT_SYMBOL_GPL(ide_queue_sense_rq
);
243 * Called when an error was detected during the last packet command.
244 * We queue a request sense packet command at the head of the request
247 void ide_retry_pc(ide_drive_t
*drive
)
249 struct request
*failed_rq
= drive
->hwif
->rq
;
250 struct request
*sense_rq
= &drive
->sense_rq
;
251 struct ide_atapi_pc
*pc
= &drive
->request_sense_pc
;
253 (void)ide_read_error(drive
);
255 /* init pc from sense_rq */
257 memcpy(pc
->c
, sense_rq
->cmd
, 12);
258 pc
->buf
= bio_data(sense_rq
->bio
); /* pointer to mapped address */
259 pc
->req_xfer
= blk_rq_bytes(sense_rq
);
261 if (drive
->media
== ide_tape
)
262 drive
->atapi_flags
|= IDE_AFLAG_IGNORE_DSC
;
265 * Push back the failed request and put request sense on top
266 * of it. The failed command will be retried after sense data
269 blk_requeue_request(failed_rq
->q
, failed_rq
);
270 drive
->hwif
->rq
= NULL
;
271 if (ide_queue_sense_rq(drive
, pc
)) {
272 blk_start_request(failed_rq
);
273 ide_complete_rq(drive
, -EIO
, blk_rq_bytes(failed_rq
));
276 EXPORT_SYMBOL_GPL(ide_retry_pc
);
278 int ide_cd_expiry(ide_drive_t
*drive
)
280 struct request
*rq
= drive
->hwif
->rq
;
281 unsigned long wait
= 0;
283 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__
, rq
->cmd
[0]);
286 * Some commands are *slow* and normally take a long time to complete.
287 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
288 * commands/drives support that. Let ide_timer_expiry keep polling us
291 switch (rq
->cmd
[0]) {
293 case GPCMD_FORMAT_UNIT
:
294 case GPCMD_RESERVE_RZONE_TRACK
:
295 case GPCMD_CLOSE_TRACK
:
296 case GPCMD_FLUSH_CACHE
:
297 wait
= ATAPI_WAIT_PC
;
300 if (!(rq
->cmd_flags
& REQ_QUIET
))
301 printk(KERN_INFO
"cmd 0x%x timed out\n",
308 EXPORT_SYMBOL_GPL(ide_cd_expiry
);
310 int ide_cd_get_xferlen(struct request
*rq
)
312 if (blk_fs_request(rq
))
314 else if (blk_sense_request(rq
) || blk_pc_request(rq
) ||
315 rq
->cmd_type
== REQ_TYPE_ATA_PC
)
316 return blk_rq_bytes(rq
);
320 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen
);
322 void ide_read_bcount_and_ireason(ide_drive_t
*drive
, u16
*bcount
, u8
*ireason
)
324 struct ide_taskfile tf
;
326 drive
->hwif
->tp_ops
->tf_read(drive
, &tf
, IDE_VALID_NSECT
|
327 IDE_VALID_LBAM
| IDE_VALID_LBAH
);
329 *bcount
= (tf
.lbah
<< 8) | tf
.lbam
;
330 *ireason
= tf
.nsect
& 3;
332 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason
);
335 * This is the usual interrupt handler which will be called during a packet
336 * command. We will transfer some of the data (as requested by the drive)
337 * and will re-point interrupt handler to us.
339 static ide_startstop_t
ide_pc_intr(ide_drive_t
*drive
)
341 struct ide_atapi_pc
*pc
= drive
->pc
;
342 ide_hwif_t
*hwif
= drive
->hwif
;
343 struct ide_cmd
*cmd
= &hwif
->cmd
;
344 struct request
*rq
= hwif
->rq
;
345 const struct ide_tp_ops
*tp_ops
= hwif
->tp_ops
;
346 unsigned int timeout
, done
;
348 u8 stat
, ireason
, dsc
= 0;
349 u8 write
= !!(pc
->flags
& PC_FLAG_WRITING
);
351 debug_log("Enter %s - interrupt handler\n", __func__
);
353 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
356 /* Clear the interrupt */
357 stat
= tp_ops
->read_status(hwif
);
359 if (pc
->flags
& PC_FLAG_DMA_IN_PROGRESS
) {
362 drive
->waiting_for_dma
= 0;
363 rc
= hwif
->dma_ops
->dma_end(drive
);
364 ide_dma_unmap_sg(drive
, cmd
);
366 if (rc
|| (drive
->media
== ide_tape
&& (stat
& ATA_ERR
))) {
367 if (drive
->media
== ide_floppy
)
368 printk(KERN_ERR
"%s: DMA %s error\n",
369 drive
->name
, rq_data_dir(pc
->rq
)
371 pc
->flags
|= PC_FLAG_DMA_ERROR
;
373 pc
->xferred
= pc
->req_xfer
;
374 debug_log("%s: DMA finished\n", drive
->name
);
377 /* No more interrupts */
378 if ((stat
& ATA_DRQ
) == 0) {
381 debug_log("Packet command completed, %d bytes transferred\n",
384 pc
->flags
&= ~PC_FLAG_DMA_IN_PROGRESS
;
386 local_irq_enable_in_hardirq();
388 if (drive
->media
== ide_tape
&&
389 (stat
& ATA_ERR
) && rq
->cmd
[0] == REQUEST_SENSE
)
392 if ((stat
& ATA_ERR
) || (pc
->flags
& PC_FLAG_DMA_ERROR
)) {
394 debug_log("%s: I/O error\n", drive
->name
);
396 if (drive
->media
!= ide_tape
)
399 if (rq
->cmd
[0] == REQUEST_SENSE
) {
400 printk(KERN_ERR
"%s: I/O error in request sense"
401 " command\n", drive
->name
);
402 return ide_do_reset(drive
);
405 debug_log("[cmd %x]: check condition\n", rq
->cmd
[0]);
407 /* Retry operation */
410 /* queued, but not started */
415 if ((pc
->flags
& PC_FLAG_WAIT_FOR_DSC
) && (stat
& ATA_DSC
) == 0)
419 * ->pc_callback() might change rq->data_len for
420 * residual count, cache total length.
422 done
= blk_rq_bytes(rq
);
424 /* Command finished - Call the callback function */
425 uptodate
= drive
->pc_callback(drive
, dsc
);
428 drive
->failed_pc
= NULL
;
430 if (blk_special_request(rq
)) {
435 if (blk_fs_request(rq
) == 0 && uptodate
<= 0) {
440 error
= uptodate
? 0 : -EIO
;
443 ide_complete_rq(drive
, error
, blk_rq_bytes(rq
));
447 if (pc
->flags
& PC_FLAG_DMA_IN_PROGRESS
) {
448 pc
->flags
&= ~PC_FLAG_DMA_IN_PROGRESS
;
449 printk(KERN_ERR
"%s: The device wants to issue more interrupts "
450 "in DMA mode\n", drive
->name
);
452 return ide_do_reset(drive
);
455 /* Get the number of bytes to transfer on this interrupt. */
456 ide_read_bcount_and_ireason(drive
, &bcount
, &ireason
);
458 if (ireason
& ATAPI_COD
) {
459 printk(KERN_ERR
"%s: CoD != 0 in %s\n", drive
->name
, __func__
);
460 return ide_do_reset(drive
);
463 if (((ireason
& ATAPI_IO
) == ATAPI_IO
) == write
) {
464 /* Hopefully, we will never get here */
465 printk(KERN_ERR
"%s: We wanted to %s, but the device wants us "
466 "to %s!\n", drive
->name
,
467 (ireason
& ATAPI_IO
) ? "Write" : "Read",
468 (ireason
& ATAPI_IO
) ? "Read" : "Write");
469 return ide_do_reset(drive
);
472 done
= min_t(unsigned int, bcount
, cmd
->nleft
);
473 ide_pio_bytes(drive
, cmd
, write
, done
);
475 /* Update transferred byte count */
481 ide_pad_transfer(drive
, write
, bcount
);
483 debug_log("[cmd %x] transferred %d bytes, padded %d bytes\n",
484 rq
->cmd
[0], done
, bcount
);
486 /* And set the interrupt handler again */
487 ide_set_handler(drive
, ide_pc_intr
, timeout
);
491 static void ide_init_packet_cmd(struct ide_cmd
*cmd
, u8 valid_tf
,
494 cmd
->protocol
= dma
? ATAPI_PROT_DMA
: ATAPI_PROT_PIO
;
495 cmd
->valid
.out
.tf
= IDE_VALID_LBAH
| IDE_VALID_LBAM
|
496 IDE_VALID_FEATURE
| valid_tf
;
497 cmd
->tf
.command
= ATA_CMD_PACKET
;
498 cmd
->tf
.feature
= dma
; /* Use PIO/DMA */
499 cmd
->tf
.lbam
= bcount
& 0xff;
500 cmd
->tf
.lbah
= (bcount
>> 8) & 0xff;
503 static u8
ide_read_ireason(ide_drive_t
*drive
)
505 struct ide_taskfile tf
;
507 drive
->hwif
->tp_ops
->tf_read(drive
, &tf
, IDE_VALID_NSECT
);
512 static u8
ide_wait_ireason(ide_drive_t
*drive
, u8 ireason
)
516 while (retries
-- && ((ireason
& ATAPI_COD
) == 0 ||
517 (ireason
& ATAPI_IO
))) {
518 printk(KERN_ERR
"%s: (IO,CoD != (0,1) while issuing "
519 "a packet command, retrying\n", drive
->name
);
521 ireason
= ide_read_ireason(drive
);
523 printk(KERN_ERR
"%s: (IO,CoD != (0,1) while issuing "
524 "a packet command, ignoring\n",
526 ireason
|= ATAPI_COD
;
527 ireason
&= ~ATAPI_IO
;
534 static int ide_delayed_transfer_pc(ide_drive_t
*drive
)
536 /* Send the actual packet */
537 drive
->hwif
->tp_ops
->output_data(drive
, NULL
, drive
->pc
->c
, 12);
539 /* Timeout for the packet command */
540 return WAIT_FLOPPY_CMD
;
543 static ide_startstop_t
ide_transfer_pc(ide_drive_t
*drive
)
545 struct ide_atapi_pc
*uninitialized_var(pc
);
546 ide_hwif_t
*hwif
= drive
->hwif
;
547 struct request
*rq
= hwif
->rq
;
548 ide_expiry_t
*expiry
;
549 unsigned int timeout
;
551 ide_startstop_t startstop
;
554 if (ide_wait_stat(&startstop
, drive
, ATA_DRQ
, ATA_BUSY
, WAIT_READY
)) {
555 printk(KERN_ERR
"%s: Strange, packet command initiated yet "
556 "DRQ isn't asserted\n", drive
->name
);
560 if (drive
->atapi_flags
& IDE_AFLAG_DRQ_INTERRUPT
) {
562 drive
->waiting_for_dma
= 1;
565 if (dev_is_idecd(drive
)) {
566 /* ATAPI commands get padded out to 12 bytes minimum */
567 cmd_len
= COMMAND_SIZE(rq
->cmd
[0]);
568 if (cmd_len
< ATAPI_MIN_CDB_BYTES
)
569 cmd_len
= ATAPI_MIN_CDB_BYTES
;
571 timeout
= rq
->timeout
;
572 expiry
= ide_cd_expiry
;
576 cmd_len
= ATAPI_MIN_CDB_BYTES
;
579 * If necessary schedule the packet transfer to occur 'timeout'
580 * milliseconds later in ide_delayed_transfer_pc() after the
581 * device says it's ready for a packet.
583 if (drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) {
584 timeout
= drive
->pc_delay
;
585 expiry
= &ide_delayed_transfer_pc
;
587 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
592 ireason
= ide_read_ireason(drive
);
593 if (drive
->media
== ide_tape
)
594 ireason
= ide_wait_ireason(drive
, ireason
);
596 if ((ireason
& ATAPI_COD
) == 0 || (ireason
& ATAPI_IO
)) {
597 printk(KERN_ERR
"%s: (IO,CoD) != (0,1) while issuing "
598 "a packet command\n", drive
->name
);
600 return ide_do_reset(drive
);
604 hwif
->expiry
= expiry
;
606 /* Set the interrupt routine */
607 ide_set_handler(drive
,
608 (dev_is_idecd(drive
) ? drive
->irq_handler
612 /* Send the actual packet */
613 if ((drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) == 0)
614 hwif
->tp_ops
->output_data(drive
, NULL
, rq
->cmd
, cmd_len
);
616 /* Begin DMA, if necessary */
617 if (dev_is_idecd(drive
)) {
619 hwif
->dma_ops
->dma_start(drive
);
621 if (pc
->flags
& PC_FLAG_DMA_OK
) {
622 pc
->flags
|= PC_FLAG_DMA_IN_PROGRESS
;
623 hwif
->dma_ops
->dma_start(drive
);
630 ide_startstop_t
ide_issue_pc(ide_drive_t
*drive
, struct ide_cmd
*cmd
)
632 struct ide_atapi_pc
*pc
;
633 ide_hwif_t
*hwif
= drive
->hwif
;
634 ide_expiry_t
*expiry
= NULL
;
635 struct request
*rq
= hwif
->rq
;
636 unsigned int timeout
;
639 u8 drq_int
= !!(drive
->atapi_flags
& IDE_AFLAG_DRQ_INTERRUPT
);
641 if (dev_is_idecd(drive
)) {
642 valid_tf
= IDE_VALID_NSECT
| IDE_VALID_LBAL
;
643 bcount
= ide_cd_get_xferlen(rq
);
644 expiry
= ide_cd_expiry
;
645 timeout
= ATAPI_WAIT_PC
;
648 drive
->dma
= !ide_dma_prepare(drive
, cmd
);
652 /* We haven't transferred any data yet */
655 valid_tf
= IDE_VALID_DEVICE
;
656 bcount
= ((drive
->media
== ide_tape
) ?
658 min(pc
->req_xfer
, 63 * 1024));
660 if (pc
->flags
& PC_FLAG_DMA_ERROR
) {
661 pc
->flags
&= ~PC_FLAG_DMA_ERROR
;
665 if (pc
->flags
& PC_FLAG_DMA_OK
)
666 drive
->dma
= !ide_dma_prepare(drive
, cmd
);
669 pc
->flags
&= ~PC_FLAG_DMA_OK
;
671 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
675 ide_init_packet_cmd(cmd
, valid_tf
, bcount
, drive
->dma
);
677 (void)do_rw_taskfile(drive
, cmd
);
681 drive
->waiting_for_dma
= 0;
682 hwif
->expiry
= expiry
;
685 ide_execute_command(drive
, cmd
, ide_transfer_pc
, timeout
);
687 return drq_int
? ide_started
: ide_transfer_pc(drive
);
689 EXPORT_SYMBOL_GPL(ide_issue_pc
);