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
);
97 rq
->cmd_type
= REQ_TYPE_DRV_PRIV
;
98 rq
->special
= (char *)pc
;
100 if (buf
&& bufflen
) {
101 error
= blk_rq_map_kern(drive
->queue
, rq
, buf
, bufflen
,
107 memcpy(scsi_req(rq
)->cmd
, pc
->c
, 12);
108 if (drive
->media
== ide_tape
)
109 scsi_req(rq
)->cmd
[13] = REQ_IDETAPE_PC1
;
110 error
= blk_execute_rq(drive
->queue
, disk
, rq
, 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 (rq
->cmd_type
== REQ_TYPE_ATA_SENSE
|| drive
->sense_rq_armed
)
199 memset(sense
, 0, sizeof(*sense
));
201 blk_rq_init(rq
->q
, sense_rq
);
202 scsi_req_init(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_type
= REQ_TYPE_ATA_SENSE
;
215 sense_rq
->rq_flags
|= RQF_PREEMPT
;
217 req
->cmd
[0] = GPCMD_REQUEST_SENSE
;
218 req
->cmd
[4] = cmd_len
;
219 if (drive
->media
== ide_tape
)
220 req
->cmd
[13] = REQ_IDETAPE_PC1
;
222 drive
->sense_rq_armed
= true;
224 EXPORT_SYMBOL_GPL(ide_prep_sense
);
226 int ide_queue_sense_rq(ide_drive_t
*drive
, void *special
)
228 /* deferred failure from ide_prep_sense() */
229 if (!drive
->sense_rq_armed
) {
230 printk(KERN_WARNING PFX
"%s: error queuing a sense request\n",
235 drive
->sense_rq
->special
= special
;
236 drive
->sense_rq_armed
= false;
238 drive
->hwif
->rq
= NULL
;
240 elv_add_request(drive
->queue
, drive
->sense_rq
, ELEVATOR_INSERT_FRONT
);
243 EXPORT_SYMBOL_GPL(ide_queue_sense_rq
);
246 * Called when an error was detected during the last packet command.
247 * We queue a request sense packet command at the head of the request
250 void ide_retry_pc(ide_drive_t
*drive
)
252 struct request
*failed_rq
= drive
->hwif
->rq
;
253 struct request
*sense_rq
= drive
->sense_rq
;
254 struct ide_atapi_pc
*pc
= &drive
->request_sense_pc
;
256 (void)ide_read_error(drive
);
258 /* init pc from sense_rq */
260 memcpy(pc
->c
, scsi_req(sense_rq
)->cmd
, 12);
262 if (drive
->media
== ide_tape
)
263 drive
->atapi_flags
|= IDE_AFLAG_IGNORE_DSC
;
266 * Push back the failed request and put request sense on top
267 * of it. The failed command will be retried after sense data
270 drive
->hwif
->rq
= NULL
;
271 ide_requeue_and_plug(drive
, failed_rq
);
272 if (ide_queue_sense_rq(drive
, pc
)) {
273 blk_start_request(failed_rq
);
274 ide_complete_rq(drive
, -EIO
, blk_rq_bytes(failed_rq
));
277 EXPORT_SYMBOL_GPL(ide_retry_pc
);
279 int ide_cd_expiry(ide_drive_t
*drive
)
281 struct request
*rq
= drive
->hwif
->rq
;
282 unsigned long wait
= 0;
284 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__
, rq
->cmd
[0]);
287 * Some commands are *slow* and normally take a long time to complete.
288 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
289 * commands/drives support that. Let ide_timer_expiry keep polling us
292 switch (scsi_req(rq
)->cmd
[0]) {
294 case GPCMD_FORMAT_UNIT
:
295 case GPCMD_RESERVE_RZONE_TRACK
:
296 case GPCMD_CLOSE_TRACK
:
297 case GPCMD_FLUSH_CACHE
:
298 wait
= ATAPI_WAIT_PC
;
301 if (!(rq
->rq_flags
& RQF_QUIET
))
302 printk(KERN_INFO PFX
"cmd 0x%x timed out\n",
303 scsi_req(rq
)->cmd
[0]);
309 EXPORT_SYMBOL_GPL(ide_cd_expiry
);
311 int ide_cd_get_xferlen(struct request
*rq
)
313 switch (rq
->cmd_type
) {
316 case REQ_TYPE_ATA_SENSE
:
317 case REQ_TYPE_BLOCK_PC
:
318 case REQ_TYPE_ATA_PC
:
319 return blk_rq_bytes(rq
);
324 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen
);
326 void ide_read_bcount_and_ireason(ide_drive_t
*drive
, u16
*bcount
, u8
*ireason
)
328 struct ide_taskfile tf
;
330 drive
->hwif
->tp_ops
->tf_read(drive
, &tf
, IDE_VALID_NSECT
|
331 IDE_VALID_LBAM
| IDE_VALID_LBAH
);
333 *bcount
= (tf
.lbah
<< 8) | tf
.lbam
;
334 *ireason
= tf
.nsect
& 3;
336 EXPORT_SYMBOL_GPL(ide_read_bcount_and_ireason
);
339 * Check the contents of the interrupt reason register and attempt to recover if
340 * there are problems.
343 * - 0 if everything's ok
344 * - 1 if the request has to be terminated.
346 int ide_check_ireason(ide_drive_t
*drive
, struct request
*rq
, int len
,
349 ide_hwif_t
*hwif
= drive
->hwif
;
351 debug_log("ireason: 0x%x, rw: 0x%x\n", ireason
, rw
);
353 if (ireason
== (!rw
<< 1))
355 else if (ireason
== (rw
<< 1)) {
356 printk(KERN_ERR PFX
"%s: %s: wrong transfer direction!\n",
357 drive
->name
, __func__
);
359 if (dev_is_idecd(drive
))
360 ide_pad_transfer(drive
, rw
, len
);
361 } else if (!rw
&& ireason
== ATAPI_COD
) {
362 if (dev_is_idecd(drive
)) {
364 * Some drives (ASUS) seem to tell us that status info
365 * is available. Just get it and ignore.
367 (void)hwif
->tp_ops
->read_status(hwif
);
371 if (ireason
& ATAPI_COD
)
372 printk(KERN_ERR PFX
"%s: CoD != 0 in %s\n", drive
->name
,
375 /* drive wants a command packet, or invalid ireason... */
376 printk(KERN_ERR PFX
"%s: %s: bad interrupt reason 0x%02x\n",
377 drive
->name
, __func__
, ireason
);
380 if (dev_is_idecd(drive
) && rq
->cmd_type
== REQ_TYPE_ATA_PC
)
381 rq
->rq_flags
|= RQF_FAILED
;
385 EXPORT_SYMBOL_GPL(ide_check_ireason
);
388 * This is the usual interrupt handler which will be called during a packet
389 * command. We will transfer some of the data (as requested by the drive)
390 * and will re-point interrupt handler to us.
392 static ide_startstop_t
ide_pc_intr(ide_drive_t
*drive
)
394 struct ide_atapi_pc
*pc
= drive
->pc
;
395 ide_hwif_t
*hwif
= drive
->hwif
;
396 struct ide_cmd
*cmd
= &hwif
->cmd
;
397 struct request
*rq
= hwif
->rq
;
398 const struct ide_tp_ops
*tp_ops
= hwif
->tp_ops
;
399 unsigned int timeout
, done
;
401 u8 stat
, ireason
, dsc
= 0;
402 u8 write
= !!(pc
->flags
& PC_FLAG_WRITING
);
404 debug_log("Enter %s - interrupt handler\n", __func__
);
406 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
409 /* Clear the interrupt */
410 stat
= tp_ops
->read_status(hwif
);
412 if (pc
->flags
& PC_FLAG_DMA_IN_PROGRESS
) {
415 drive
->waiting_for_dma
= 0;
416 rc
= hwif
->dma_ops
->dma_end(drive
);
417 ide_dma_unmap_sg(drive
, cmd
);
419 if (rc
|| (drive
->media
== ide_tape
&& (stat
& ATA_ERR
))) {
420 if (drive
->media
== ide_floppy
)
421 printk(KERN_ERR PFX
"%s: DMA %s error\n",
422 drive
->name
, rq_data_dir(pc
->rq
)
424 pc
->flags
|= PC_FLAG_DMA_ERROR
;
426 scsi_req(rq
)->resid_len
= 0;
427 debug_log("%s: DMA finished\n", drive
->name
);
430 /* No more interrupts */
431 if ((stat
& ATA_DRQ
) == 0) {
434 debug_log("Packet command completed, %d bytes transferred\n",
437 pc
->flags
&= ~PC_FLAG_DMA_IN_PROGRESS
;
439 local_irq_enable_in_hardirq();
441 if (drive
->media
== ide_tape
&&
442 (stat
& ATA_ERR
) && scsi_req(rq
)->cmd
[0] == REQUEST_SENSE
)
445 if ((stat
& ATA_ERR
) || (pc
->flags
& PC_FLAG_DMA_ERROR
)) {
447 debug_log("%s: I/O error\n", drive
->name
);
449 if (drive
->media
!= ide_tape
)
452 if (scsi_req(rq
)->cmd
[0] == REQUEST_SENSE
) {
453 printk(KERN_ERR PFX
"%s: I/O error in request "
454 "sense command\n", drive
->name
);
455 return ide_do_reset(drive
);
458 debug_log("[cmd %x]: check condition\n", rq
->cmd
[0]);
460 /* Retry operation */
463 /* queued, but not started */
468 if ((pc
->flags
& PC_FLAG_WAIT_FOR_DSC
) && (stat
& ATA_DSC
) == 0)
472 * ->pc_callback() might change rq->data_len for
473 * residual count, cache total length.
475 done
= blk_rq_bytes(rq
);
477 /* Command finished - Call the callback function */
478 uptodate
= drive
->pc_callback(drive
, dsc
);
481 drive
->failed_pc
= NULL
;
483 if (rq
->cmd_type
== REQ_TYPE_DRV_PRIV
) {
488 if (rq
->cmd_type
!= REQ_TYPE_FS
&& uptodate
<= 0) {
493 error
= uptodate
? 0 : -EIO
;
496 ide_complete_rq(drive
, error
, blk_rq_bytes(rq
));
500 if (pc
->flags
& PC_FLAG_DMA_IN_PROGRESS
) {
501 pc
->flags
&= ~PC_FLAG_DMA_IN_PROGRESS
;
502 printk(KERN_ERR PFX
"%s: The device wants to issue more "
503 "interrupts in DMA mode\n", drive
->name
);
505 return ide_do_reset(drive
);
508 /* Get the number of bytes to transfer on this interrupt. */
509 ide_read_bcount_and_ireason(drive
, &bcount
, &ireason
);
511 if (ide_check_ireason(drive
, rq
, bcount
, ireason
, write
))
512 return ide_do_reset(drive
);
514 done
= min_t(unsigned int, bcount
, cmd
->nleft
);
515 ide_pio_bytes(drive
, cmd
, write
, done
);
517 /* Update transferred byte count */
518 scsi_req(rq
)->resid_len
-= done
;
523 ide_pad_transfer(drive
, write
, bcount
);
525 debug_log("[cmd %x] transferred %d bytes, padded %d bytes, resid: %u\n",
526 rq
->cmd
[0], done
, bcount
, scsi_req(rq
)->resid_len
);
528 /* And set the interrupt handler again */
529 ide_set_handler(drive
, ide_pc_intr
, timeout
);
533 static void ide_init_packet_cmd(struct ide_cmd
*cmd
, u8 valid_tf
,
536 cmd
->protocol
= dma
? ATAPI_PROT_DMA
: ATAPI_PROT_PIO
;
537 cmd
->valid
.out
.tf
= IDE_VALID_LBAH
| IDE_VALID_LBAM
|
538 IDE_VALID_FEATURE
| valid_tf
;
539 cmd
->tf
.command
= ATA_CMD_PACKET
;
540 cmd
->tf
.feature
= dma
; /* Use PIO/DMA */
541 cmd
->tf
.lbam
= bcount
& 0xff;
542 cmd
->tf
.lbah
= (bcount
>> 8) & 0xff;
545 static u8
ide_read_ireason(ide_drive_t
*drive
)
547 struct ide_taskfile tf
;
549 drive
->hwif
->tp_ops
->tf_read(drive
, &tf
, IDE_VALID_NSECT
);
554 static u8
ide_wait_ireason(ide_drive_t
*drive
, u8 ireason
)
558 while (retries
-- && ((ireason
& ATAPI_COD
) == 0 ||
559 (ireason
& ATAPI_IO
))) {
560 printk(KERN_ERR PFX
"%s: (IO,CoD != (0,1) while issuing "
561 "a packet command, retrying\n", drive
->name
);
563 ireason
= ide_read_ireason(drive
);
565 printk(KERN_ERR PFX
"%s: (IO,CoD != (0,1) while issuing"
566 " a packet command, ignoring\n",
568 ireason
|= ATAPI_COD
;
569 ireason
&= ~ATAPI_IO
;
576 static int ide_delayed_transfer_pc(ide_drive_t
*drive
)
578 /* Send the actual packet */
579 drive
->hwif
->tp_ops
->output_data(drive
, NULL
, drive
->pc
->c
, 12);
581 /* Timeout for the packet command */
582 return WAIT_FLOPPY_CMD
;
585 static ide_startstop_t
ide_transfer_pc(ide_drive_t
*drive
)
587 struct ide_atapi_pc
*uninitialized_var(pc
);
588 ide_hwif_t
*hwif
= drive
->hwif
;
589 struct request
*rq
= hwif
->rq
;
590 ide_expiry_t
*expiry
;
591 unsigned int timeout
;
593 ide_startstop_t startstop
;
596 if (ide_wait_stat(&startstop
, drive
, ATA_DRQ
, ATA_BUSY
, WAIT_READY
)) {
597 printk(KERN_ERR PFX
"%s: Strange, packet command initiated yet "
598 "DRQ isn't asserted\n", drive
->name
);
602 if (drive
->atapi_flags
& IDE_AFLAG_DRQ_INTERRUPT
) {
604 drive
->waiting_for_dma
= 1;
607 if (dev_is_idecd(drive
)) {
608 /* ATAPI commands get padded out to 12 bytes minimum */
609 cmd_len
= COMMAND_SIZE(scsi_req(rq
)->cmd
[0]);
610 if (cmd_len
< ATAPI_MIN_CDB_BYTES
)
611 cmd_len
= ATAPI_MIN_CDB_BYTES
;
613 timeout
= rq
->timeout
;
614 expiry
= ide_cd_expiry
;
618 cmd_len
= ATAPI_MIN_CDB_BYTES
;
621 * If necessary schedule the packet transfer to occur 'timeout'
622 * milliseconds later in ide_delayed_transfer_pc() after the
623 * device says it's ready for a packet.
625 if (drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) {
626 timeout
= drive
->pc_delay
;
627 expiry
= &ide_delayed_transfer_pc
;
629 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
634 ireason
= ide_read_ireason(drive
);
635 if (drive
->media
== ide_tape
)
636 ireason
= ide_wait_ireason(drive
, ireason
);
638 if ((ireason
& ATAPI_COD
) == 0 || (ireason
& ATAPI_IO
)) {
639 printk(KERN_ERR PFX
"%s: (IO,CoD) != (0,1) while "
640 "issuing a packet command\n", drive
->name
);
642 return ide_do_reset(drive
);
646 hwif
->expiry
= expiry
;
648 /* Set the interrupt routine */
649 ide_set_handler(drive
,
650 (dev_is_idecd(drive
) ? drive
->irq_handler
654 /* Send the actual packet */
655 if ((drive
->atapi_flags
& IDE_AFLAG_ZIP_DRIVE
) == 0)
656 hwif
->tp_ops
->output_data(drive
, NULL
, scsi_req(rq
)->cmd
, cmd_len
);
658 /* Begin DMA, if necessary */
659 if (dev_is_idecd(drive
)) {
661 hwif
->dma_ops
->dma_start(drive
);
663 if (pc
->flags
& PC_FLAG_DMA_OK
) {
664 pc
->flags
|= PC_FLAG_DMA_IN_PROGRESS
;
665 hwif
->dma_ops
->dma_start(drive
);
672 ide_startstop_t
ide_issue_pc(ide_drive_t
*drive
, struct ide_cmd
*cmd
)
674 struct ide_atapi_pc
*pc
;
675 ide_hwif_t
*hwif
= drive
->hwif
;
676 ide_expiry_t
*expiry
= NULL
;
677 struct request
*rq
= hwif
->rq
;
678 unsigned int timeout
, bytes
;
681 u8 drq_int
= !!(drive
->atapi_flags
& IDE_AFLAG_DRQ_INTERRUPT
);
683 if (dev_is_idecd(drive
)) {
684 valid_tf
= IDE_VALID_NSECT
| IDE_VALID_LBAL
;
685 bcount
= ide_cd_get_xferlen(rq
);
686 expiry
= ide_cd_expiry
;
687 timeout
= ATAPI_WAIT_PC
;
690 drive
->dma
= !ide_dma_prepare(drive
, cmd
);
694 valid_tf
= IDE_VALID_DEVICE
;
695 bytes
= blk_rq_bytes(rq
);
696 bcount
= ((drive
->media
== ide_tape
) ? bytes
697 : min_t(unsigned int,
700 /* We haven't transferred any data yet */
701 scsi_req(rq
)->resid_len
= bcount
;
703 if (pc
->flags
& PC_FLAG_DMA_ERROR
) {
704 pc
->flags
&= ~PC_FLAG_DMA_ERROR
;
708 if (pc
->flags
& PC_FLAG_DMA_OK
)
709 drive
->dma
= !ide_dma_prepare(drive
, cmd
);
712 pc
->flags
&= ~PC_FLAG_DMA_OK
;
714 timeout
= (drive
->media
== ide_floppy
) ? WAIT_FLOPPY_CMD
718 ide_init_packet_cmd(cmd
, valid_tf
, bcount
, drive
->dma
);
720 (void)do_rw_taskfile(drive
, cmd
);
724 drive
->waiting_for_dma
= 0;
725 hwif
->expiry
= expiry
;
728 ide_execute_command(drive
, cmd
, ide_transfer_pc
, timeout
);
730 return drq_int
? ide_started
: ide_transfer_pc(drive
);
732 EXPORT_SYMBOL_GPL(ide_issue_pc
);