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
, READ
, __GFP_RECLAIM
);
96 rq
->cmd_type
= REQ_TYPE_DRV_PRIV
;
97 rq
->special
= (char *)pc
;
100 error
= blk_rq_map_kern(drive
->queue
, rq
, buf
, bufflen
,
106 memcpy(rq
->cmd
, pc
->c
, 12);
107 if (drive
->media
== ide_tape
)
108 rq
->cmd
[13] = REQ_IDETAPE_PC1
;
109 error
= blk_execute_rq(drive
->queue
, disk
, rq
, 0);
114 EXPORT_SYMBOL_GPL(ide_queue_pc_tail
);
116 int ide_do_test_unit_ready(ide_drive_t
*drive
, struct gendisk
*disk
)
118 struct ide_atapi_pc pc
;
121 pc
.c
[0] = TEST_UNIT_READY
;
123 return ide_queue_pc_tail(drive
, disk
, &pc
, NULL
, 0);
125 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready
);
127 int ide_do_start_stop(ide_drive_t
*drive
, struct gendisk
*disk
, int start
)
129 struct ide_atapi_pc pc
;
132 pc
.c
[0] = START_STOP
;
135 if (drive
->media
== ide_tape
)
136 pc
.flags
|= PC_FLAG_WAIT_FOR_DSC
;
138 return ide_queue_pc_tail(drive
, disk
, &pc
, NULL
, 0);
140 EXPORT_SYMBOL_GPL(ide_do_start_stop
);
142 int ide_set_media_lock(ide_drive_t
*drive
, struct gendisk
*disk
, int on
)
144 struct ide_atapi_pc pc
;
146 if ((drive
->dev_flags
& IDE_DFLAG_DOORLOCKING
) == 0)
150 pc
.c
[0] = ALLOW_MEDIUM_REMOVAL
;
153 return ide_queue_pc_tail(drive
, disk
, &pc
, NULL
, 0);
155 EXPORT_SYMBOL_GPL(ide_set_media_lock
);
157 void ide_create_request_sense_cmd(ide_drive_t
*drive
, struct ide_atapi_pc
*pc
)
160 pc
->c
[0] = REQUEST_SENSE
;
161 if (drive
->media
== ide_floppy
) {
169 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd
);
171 void ide_prep_sense(ide_drive_t
*drive
, struct request
*rq
)
173 struct request_sense
*sense
= &drive
->sense_data
;
174 struct request
*sense_rq
= &drive
->sense_rq
;
175 unsigned int cmd_len
, sense_len
;
178 switch (drive
->media
) {
192 BUG_ON(sense_len
> sizeof(*sense
));
194 if (rq
->cmd_type
== REQ_TYPE_ATA_SENSE
|| drive
->sense_rq_armed
)
197 memset(sense
, 0, sizeof(*sense
));
199 blk_rq_init(rq
->q
, sense_rq
);
201 err
= blk_rq_map_kern(drive
->queue
, sense_rq
, sense
, sense_len
,
204 if (printk_ratelimit())
205 printk(KERN_WARNING PFX
"%s: failed to map sense "
206 "buffer\n", drive
->name
);
210 sense_rq
->rq_disk
= rq
->rq_disk
;
211 sense_rq
->cmd
[0] = GPCMD_REQUEST_SENSE
;
212 sense_rq
->cmd
[4] = cmd_len
;
213 sense_rq
->cmd_type
= REQ_TYPE_ATA_SENSE
;
214 sense_rq
->cmd_flags
|= REQ_PREEMPT
;
216 if (drive
->media
== ide_tape
)
217 sense_rq
->cmd
[13] = REQ_IDETAPE_PC1
;
219 drive
->sense_rq_armed
= true;
221 EXPORT_SYMBOL_GPL(ide_prep_sense
);
223 int ide_queue_sense_rq(ide_drive_t
*drive
, void *special
)
225 /* deferred failure from ide_prep_sense() */
226 if (!drive
->sense_rq_armed
) {
227 printk(KERN_WARNING PFX
"%s: error queuing a sense request\n",
232 drive
->sense_rq
.special
= special
;
233 drive
->sense_rq_armed
= false;
235 drive
->hwif
->rq
= NULL
;
237 elv_add_request(drive
->queue
, &drive
->sense_rq
, ELEVATOR_INSERT_FRONT
);
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);
259 if (drive
->media
== ide_tape
)
260 drive
->atapi_flags
|= IDE_AFLAG_IGNORE_DSC
;
263 * Push back the failed request and put request sense on top
264 * of it. The failed command will be retried after sense data
267 drive
->hwif
->rq
= NULL
;
268 ide_requeue_and_plug(drive
, failed_rq
);
269 if (ide_queue_sense_rq(drive
, pc
)) {
270 blk_start_request(failed_rq
);
271 ide_complete_rq(drive
, -EIO
, blk_rq_bytes(failed_rq
));
274 EXPORT_SYMBOL_GPL(ide_retry_pc
);
276 int ide_cd_expiry(ide_drive_t
*drive
)
278 struct request
*rq
= drive
->hwif
->rq
;
279 unsigned long wait
= 0;
281 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__
, rq
->cmd
[0]);
284 * Some commands are *slow* and normally take a long time to complete.
285 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
286 * commands/drives support that. Let ide_timer_expiry keep polling us
289 switch (rq
->cmd
[0]) {
291 case GPCMD_FORMAT_UNIT
:
292 case GPCMD_RESERVE_RZONE_TRACK
:
293 case GPCMD_CLOSE_TRACK
:
294 case GPCMD_FLUSH_CACHE
:
295 wait
= ATAPI_WAIT_PC
;
298 if (!(rq
->cmd_flags
& REQ_QUIET
))
299 printk(KERN_INFO PFX
"cmd 0x%x timed out\n",
306 EXPORT_SYMBOL_GPL(ide_cd_expiry
);
308 int ide_cd_get_xferlen(struct request
*rq
)
310 switch (rq
->cmd_type
) {
313 case REQ_TYPE_ATA_SENSE
:
314 case REQ_TYPE_BLOCK_PC
:
315 case REQ_TYPE_ATA_PC
:
316 return blk_rq_bytes(rq
);
321 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen
);
323 void ide_read_bcount_and_ireason(ide_drive_t
*drive
, u16
*bcount
, u8
*ireason
)
325 struct ide_taskfile tf
;
327 drive
->hwif
->tp_ops
->tf_read(drive
, &tf
, IDE_VALID_NSECT
|
328 IDE_VALID_LBAM
| IDE_VALID_LBAH
);
330 *bcount
= (tf
.lbah
<< 8) | tf
.lbam
;
331 *ireason
= tf
.nsect
& 3;
333 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason
);
336 * Check the contents of the interrupt reason register and attempt to recover if
337 * there are problems.
340 * - 0 if everything's ok
341 * - 1 if the request has to be terminated.
343 int ide_check_ireason(ide_drive_t
*drive
, struct request
*rq
, int len
,
346 ide_hwif_t
*hwif
= drive
->hwif
;
348 debug_log("ireason: 0x%x, rw: 0x%x\n", ireason
, rw
);
350 if (ireason
== (!rw
<< 1))
352 else if (ireason
== (rw
<< 1)) {
353 printk(KERN_ERR PFX
"%s: %s: wrong transfer direction!\n",
354 drive
->name
, __func__
);
356 if (dev_is_idecd(drive
))
357 ide_pad_transfer(drive
, rw
, len
);
358 } else if (!rw
&& ireason
== ATAPI_COD
) {
359 if (dev_is_idecd(drive
)) {
361 * Some drives (ASUS) seem to tell us that status info
362 * is available. Just get it and ignore.
364 (void)hwif
->tp_ops
->read_status(hwif
);
368 if (ireason
& ATAPI_COD
)
369 printk(KERN_ERR PFX
"%s: CoD != 0 in %s\n", drive
->name
,
372 /* drive wants a command packet, or invalid ireason... */
373 printk(KERN_ERR PFX
"%s: %s: bad interrupt reason 0x%02x\n",
374 drive
->name
, __func__
, ireason
);
377 if (dev_is_idecd(drive
) && rq
->cmd_type
== REQ_TYPE_ATA_PC
)
378 rq
->cmd_flags
|= REQ_FAILED
;
382 EXPORT_SYMBOL_GPL(ide_check_ireason
);
385 * This is the usual interrupt handler which will be called during a packet
386 * command. We will transfer some of the data (as requested by the drive)
387 * and will re-point interrupt handler to us.
389 static ide_startstop_t
ide_pc_intr(ide_drive_t
*drive
)
391 struct ide_atapi_pc
*pc
= drive
->pc
;
392 ide_hwif_t
*hwif
= drive
->hwif
;
393 struct ide_cmd
*cmd
= &hwif
->cmd
;
394 struct request
*rq
= hwif
->rq
;
395 const struct ide_tp_ops
*tp_ops
= hwif
->tp_ops
;
396 unsigned int timeout
, done
;
398 u8 stat
, ireason
, dsc
= 0;
399 u8 write
= !!(pc
->flags
& PC_FLAG_WRITING
);
401 debug_log("Enter %s - interrupt handler\n", __func__
);
403 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
406 /* Clear the interrupt */
407 stat
= tp_ops
->read_status(hwif
);
409 if (pc
->flags
& PC_FLAG_DMA_IN_PROGRESS
) {
412 drive
->waiting_for_dma
= 0;
413 rc
= hwif
->dma_ops
->dma_end(drive
);
414 ide_dma_unmap_sg(drive
, cmd
);
416 if (rc
|| (drive
->media
== ide_tape
&& (stat
& ATA_ERR
))) {
417 if (drive
->media
== ide_floppy
)
418 printk(KERN_ERR PFX
"%s: DMA %s error\n",
419 drive
->name
, rq_data_dir(pc
->rq
)
421 pc
->flags
|= PC_FLAG_DMA_ERROR
;
424 debug_log("%s: DMA finished\n", drive
->name
);
427 /* No more interrupts */
428 if ((stat
& ATA_DRQ
) == 0) {
431 debug_log("Packet command completed, %d bytes transferred\n",
434 pc
->flags
&= ~PC_FLAG_DMA_IN_PROGRESS
;
436 local_irq_enable_in_hardirq();
438 if (drive
->media
== ide_tape
&&
439 (stat
& ATA_ERR
) && rq
->cmd
[0] == REQUEST_SENSE
)
442 if ((stat
& ATA_ERR
) || (pc
->flags
& PC_FLAG_DMA_ERROR
)) {
444 debug_log("%s: I/O error\n", drive
->name
);
446 if (drive
->media
!= ide_tape
)
449 if (rq
->cmd
[0] == REQUEST_SENSE
) {
450 printk(KERN_ERR PFX
"%s: I/O error in request "
451 "sense command\n", drive
->name
);
452 return ide_do_reset(drive
);
455 debug_log("[cmd %x]: check condition\n", rq
->cmd
[0]);
457 /* Retry operation */
460 /* queued, but not started */
465 if ((pc
->flags
& PC_FLAG_WAIT_FOR_DSC
) && (stat
& ATA_DSC
) == 0)
469 * ->pc_callback() might change rq->data_len for
470 * residual count, cache total length.
472 done
= blk_rq_bytes(rq
);
474 /* Command finished - Call the callback function */
475 uptodate
= drive
->pc_callback(drive
, dsc
);
478 drive
->failed_pc
= NULL
;
480 if (rq
->cmd_type
== REQ_TYPE_DRV_PRIV
) {
485 if (rq
->cmd_type
!= REQ_TYPE_FS
&& uptodate
<= 0) {
490 error
= uptodate
? 0 : -EIO
;
493 ide_complete_rq(drive
, error
, blk_rq_bytes(rq
));
497 if (pc
->flags
& PC_FLAG_DMA_IN_PROGRESS
) {
498 pc
->flags
&= ~PC_FLAG_DMA_IN_PROGRESS
;
499 printk(KERN_ERR PFX
"%s: The device wants to issue more "
500 "interrupts in DMA mode\n", drive
->name
);
502 return ide_do_reset(drive
);
505 /* Get the number of bytes to transfer on this interrupt. */
506 ide_read_bcount_and_ireason(drive
, &bcount
, &ireason
);
508 if (ide_check_ireason(drive
, rq
, bcount
, ireason
, write
))
509 return ide_do_reset(drive
);
511 done
= min_t(unsigned int, bcount
, cmd
->nleft
);
512 ide_pio_bytes(drive
, cmd
, write
, done
);
514 /* Update transferred byte count */
515 rq
->resid_len
-= done
;
520 ide_pad_transfer(drive
, write
, bcount
);
522 debug_log("[cmd %x] transferred %d bytes, padded %d bytes, resid: %u\n",
523 rq
->cmd
[0], done
, bcount
, rq
->resid_len
);
525 /* And set the interrupt handler again */
526 ide_set_handler(drive
, ide_pc_intr
, timeout
);
530 static void ide_init_packet_cmd(struct ide_cmd
*cmd
, u8 valid_tf
,
533 cmd
->protocol
= dma
? ATAPI_PROT_DMA
: ATAPI_PROT_PIO
;
534 cmd
->valid
.out
.tf
= IDE_VALID_LBAH
| IDE_VALID_LBAM
|
535 IDE_VALID_FEATURE
| valid_tf
;
536 cmd
->tf
.command
= ATA_CMD_PACKET
;
537 cmd
->tf
.feature
= dma
; /* Use PIO/DMA */
538 cmd
->tf
.lbam
= bcount
& 0xff;
539 cmd
->tf
.lbah
= (bcount
>> 8) & 0xff;
542 static u8
ide_read_ireason(ide_drive_t
*drive
)
544 struct ide_taskfile tf
;
546 drive
->hwif
->tp_ops
->tf_read(drive
, &tf
, IDE_VALID_NSECT
);
551 static u8
ide_wait_ireason(ide_drive_t
*drive
, u8 ireason
)
555 while (retries
-- && ((ireason
& ATAPI_COD
) == 0 ||
556 (ireason
& ATAPI_IO
))) {
557 printk(KERN_ERR PFX
"%s: (IO,CoD != (0,1) while issuing "
558 "a packet command, retrying\n", drive
->name
);
560 ireason
= ide_read_ireason(drive
);
562 printk(KERN_ERR PFX
"%s: (IO,CoD != (0,1) while issuing"
563 " a packet command, ignoring\n",
565 ireason
|= ATAPI_COD
;
566 ireason
&= ~ATAPI_IO
;
573 static int ide_delayed_transfer_pc(ide_drive_t
*drive
)
575 /* Send the actual packet */
576 drive
->hwif
->tp_ops
->output_data(drive
, NULL
, drive
->pc
->c
, 12);
578 /* Timeout for the packet command */
579 return WAIT_FLOPPY_CMD
;
582 static ide_startstop_t
ide_transfer_pc(ide_drive_t
*drive
)
584 struct ide_atapi_pc
*uninitialized_var(pc
);
585 ide_hwif_t
*hwif
= drive
->hwif
;
586 struct request
*rq
= hwif
->rq
;
587 ide_expiry_t
*expiry
;
588 unsigned int timeout
;
590 ide_startstop_t startstop
;
593 if (ide_wait_stat(&startstop
, drive
, ATA_DRQ
, ATA_BUSY
, WAIT_READY
)) {
594 printk(KERN_ERR PFX
"%s: Strange, packet command initiated yet "
595 "DRQ isn't asserted\n", drive
->name
);
599 if (drive
->atapi_flags
& IDE_AFLAG_DRQ_INTERRUPT
) {
601 drive
->waiting_for_dma
= 1;
604 if (dev_is_idecd(drive
)) {
605 /* ATAPI commands get padded out to 12 bytes minimum */
606 cmd_len
= COMMAND_SIZE(rq
->cmd
[0]);
607 if (cmd_len
< ATAPI_MIN_CDB_BYTES
)
608 cmd_len
= ATAPI_MIN_CDB_BYTES
;
610 timeout
= rq
->timeout
;
611 expiry
= ide_cd_expiry
;
615 cmd_len
= ATAPI_MIN_CDB_BYTES
;
618 * If necessary schedule the packet transfer to occur 'timeout'
619 * milliseconds later in ide_delayed_transfer_pc() after the
620 * device says it's ready for a packet.
622 if (drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) {
623 timeout
= drive
->pc_delay
;
624 expiry
= &ide_delayed_transfer_pc
;
626 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
631 ireason
= ide_read_ireason(drive
);
632 if (drive
->media
== ide_tape
)
633 ireason
= ide_wait_ireason(drive
, ireason
);
635 if ((ireason
& ATAPI_COD
) == 0 || (ireason
& ATAPI_IO
)) {
636 printk(KERN_ERR PFX
"%s: (IO,CoD) != (0,1) while "
637 "issuing a packet command\n", drive
->name
);
639 return ide_do_reset(drive
);
643 hwif
->expiry
= expiry
;
645 /* Set the interrupt routine */
646 ide_set_handler(drive
,
647 (dev_is_idecd(drive
) ? drive
->irq_handler
651 /* Send the actual packet */
652 if ((drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) == 0)
653 hwif
->tp_ops
->output_data(drive
, NULL
, rq
->cmd
, cmd_len
);
655 /* Begin DMA, if necessary */
656 if (dev_is_idecd(drive
)) {
658 hwif
->dma_ops
->dma_start(drive
);
660 if (pc
->flags
& PC_FLAG_DMA_OK
) {
661 pc
->flags
|= PC_FLAG_DMA_IN_PROGRESS
;
662 hwif
->dma_ops
->dma_start(drive
);
669 ide_startstop_t
ide_issue_pc(ide_drive_t
*drive
, struct ide_cmd
*cmd
)
671 struct ide_atapi_pc
*pc
;
672 ide_hwif_t
*hwif
= drive
->hwif
;
673 ide_expiry_t
*expiry
= NULL
;
674 struct request
*rq
= hwif
->rq
;
675 unsigned int timeout
, bytes
;
678 u8 drq_int
= !!(drive
->atapi_flags
& IDE_AFLAG_DRQ_INTERRUPT
);
680 if (dev_is_idecd(drive
)) {
681 valid_tf
= IDE_VALID_NSECT
| IDE_VALID_LBAL
;
682 bcount
= ide_cd_get_xferlen(rq
);
683 expiry
= ide_cd_expiry
;
684 timeout
= ATAPI_WAIT_PC
;
687 drive
->dma
= !ide_dma_prepare(drive
, cmd
);
691 valid_tf
= IDE_VALID_DEVICE
;
692 bytes
= blk_rq_bytes(rq
);
693 bcount
= ((drive
->media
== ide_tape
) ? bytes
694 : min_t(unsigned int,
697 /* We haven't transferred any data yet */
698 rq
->resid_len
= bcount
;
700 if (pc
->flags
& PC_FLAG_DMA_ERROR
) {
701 pc
->flags
&= ~PC_FLAG_DMA_ERROR
;
705 if (pc
->flags
& PC_FLAG_DMA_OK
)
706 drive
->dma
= !ide_dma_prepare(drive
, cmd
);
709 pc
->flags
&= ~PC_FLAG_DMA_OK
;
711 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
715 ide_init_packet_cmd(cmd
, valid_tf
, bcount
, drive
->dma
);
717 (void)do_rw_taskfile(drive
, cmd
);
721 drive
->waiting_for_dma
= 0;
722 hwif
->expiry
= expiry
;
725 ide_execute_command(drive
, cmd
, ide_transfer_pc
, timeout
);
727 return drq_int
? ide_started
: ide_transfer_pc(drive
);
729 EXPORT_SYMBOL_GPL(ide_issue_pc
);