5 #include <linux/kernel.h>
6 #include <linux/cdrom.h>
7 #include <linux/delay.h>
12 #define debug_log(fmt, args...) \
13 printk(KERN_INFO "ide: " fmt, ## args)
15 #define debug_log(fmt, args...) do {} while (0)
18 #define ATAPI_MIN_CDB_BYTES 12
20 static inline int dev_is_idecd(ide_drive_t *drive)
22 return drive->media == ide_cdrom || drive->media == ide_optical;
26 * Check whether we can support a device,
27 * based on the ATAPI IDENTIFY command results.
29 int ide_check_atapi_device(ide_drive_t *drive, const char *s)
32 u8 gcw[2], protocol, device_type, removable, drq_type, packet_size;
34 *((u16 *)&gcw) = id[ATA_ID_CONFIG];
36 protocol = (gcw[1] & 0xC0) >> 6;
37 device_type = gcw[1] & 0x1F;
38 removable = (gcw[0] & 0x80) >> 7;
39 drq_type = (gcw[0] & 0x60) >> 5;
40 packet_size = gcw[0] & 0x03;
43 /* kludge for Apple PowerBook internal zip */
44 if (drive->media == ide_floppy && device_type == 5 &&
45 !strstr((char *)&id[ATA_ID_PROD], "CD-ROM") &&
46 strstr((char *)&id[ATA_ID_PROD], "ZIP"))
51 printk(KERN_ERR "%s: %s: protocol (0x%02x) is not ATAPI\n",
52 s, drive->name, protocol);
53 else if ((drive->media == ide_floppy && device_type != 0) ||
54 (drive->media == ide_tape && device_type != 1))
55 printk(KERN_ERR "%s: %s: invalid device type (0x%02x)\n",
56 s, drive->name, device_type);
57 else if (removable == 0)
58 printk(KERN_ERR "%s: %s: the removable flag is not set\n",
60 else if (drive->media == ide_floppy && drq_type == 3)
61 printk(KERN_ERR "%s: %s: sorry, DRQ type (0x%02x) not "
62 "supported\n", s, drive->name, drq_type);
63 else if (packet_size != 0)
64 printk(KERN_ERR "%s: %s: packet size (0x%02x) is not 12 "
65 "bytes\n", s, drive->name, packet_size);
70 EXPORT_SYMBOL_GPL(ide_check_atapi_device);
72 /* PIO data transfer routine using the scatter gather table. */
73 int ide_io_buffers(ide_drive_t *drive, struct ide_atapi_pc *pc,
74 unsigned int bcount, int write)
76 ide_hwif_t *hwif = drive->hwif;
77 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
78 xfer_func_t *xf = write ? tp_ops->output_data : tp_ops->input_data;
79 struct scatterlist *sg = pc->sg;
84 count = min(sg->length - pc->b_count, bcount);
86 if (PageHighMem(sg_page(sg))) {
89 local_irq_save(flags);
90 buf = kmap_atomic(sg_page(sg), KM_IRQ0) + sg->offset;
91 xf(drive, NULL, buf + pc->b_count, count);
92 kunmap_atomic(buf - sg->offset, KM_IRQ0);
93 local_irq_restore(flags);
96 xf(drive, NULL, buf + pc->b_count, count);
100 pc->b_count += count;
103 if (pc->b_count == sg->length) {
106 pc->sg = sg = sg_next(sg);
112 printk(KERN_ERR "%s: %d leftover bytes, %s\n", drive->name,
113 bcount, write ? "padding with zeros"
114 : "discarding data");
115 ide_pad_transfer(drive, write, bcount);
120 EXPORT_SYMBOL_GPL(ide_io_buffers);
122 void ide_init_pc(struct ide_atapi_pc *pc)
124 memset(pc, 0, sizeof(*pc));
125 pc->buf = pc->pc_buf;
126 pc->buf_size = IDE_PC_BUFFER_SIZE;
128 EXPORT_SYMBOL_GPL(ide_init_pc);
131 * Generate a new packet command request in front of the request queue, before
132 * the current request, so that it will be processed immediately, on the next
133 * pass through the driver.
135 static void ide_queue_pc_head(ide_drive_t *drive, struct gendisk *disk,
136 struct ide_atapi_pc *pc, struct request *rq)
138 blk_rq_init(NULL, rq);
139 rq->cmd_type = REQ_TYPE_SPECIAL;
140 rq->cmd_flags |= REQ_PREEMPT;
141 rq->buffer = (char *)pc;
146 rq->data_len = pc->req_xfer;
149 memcpy(rq->cmd, pc->c, 12);
150 if (drive->media == ide_tape)
151 rq->cmd[13] = REQ_IDETAPE_PC1;
152 ide_do_drive_cmd(drive, rq);
156 * Add a special packet command request to the tail of the request queue,
157 * and wait for it to be serviced.
159 int ide_queue_pc_tail(ide_drive_t *drive, struct gendisk *disk,
160 struct ide_atapi_pc *pc)
165 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
166 rq->cmd_type = REQ_TYPE_SPECIAL;
167 rq->buffer = (char *)pc;
171 rq->data_len = pc->req_xfer;
174 memcpy(rq->cmd, pc->c, 12);
175 if (drive->media == ide_tape)
176 rq->cmd[13] = REQ_IDETAPE_PC1;
177 error = blk_execute_rq(drive->queue, disk, rq, 0);
182 EXPORT_SYMBOL_GPL(ide_queue_pc_tail);
184 int ide_do_test_unit_ready(ide_drive_t *drive, struct gendisk *disk)
186 struct ide_atapi_pc pc;
189 pc.c[0] = TEST_UNIT_READY;
191 return ide_queue_pc_tail(drive, disk, &pc);
193 EXPORT_SYMBOL_GPL(ide_do_test_unit_ready);
195 int ide_do_start_stop(ide_drive_t *drive, struct gendisk *disk, int start)
197 struct ide_atapi_pc pc;
200 pc.c[0] = START_STOP;
203 if (drive->media == ide_tape)
204 pc.flags |= PC_FLAG_WAIT_FOR_DSC;
206 return ide_queue_pc_tail(drive, disk, &pc);
208 EXPORT_SYMBOL_GPL(ide_do_start_stop);
210 int ide_set_media_lock(ide_drive_t *drive, struct gendisk *disk, int on)
212 struct ide_atapi_pc pc;
214 if ((drive->dev_flags & IDE_DFLAG_DOORLOCKING) == 0)
218 pc.c[0] = ALLOW_MEDIUM_REMOVAL;
221 return ide_queue_pc_tail(drive, disk, &pc);
223 EXPORT_SYMBOL_GPL(ide_set_media_lock);
225 void ide_create_request_sense_cmd(ide_drive_t *drive, struct ide_atapi_pc *pc)
228 pc->c[0] = REQUEST_SENSE;
229 if (drive->media == ide_floppy) {
237 EXPORT_SYMBOL_GPL(ide_create_request_sense_cmd);
240 * Called when an error was detected during the last packet command.
241 * We queue a request sense packet command in the head of the request list.
243 void ide_retry_pc(ide_drive_t *drive, struct gendisk *disk)
245 struct request *rq = &drive->request_sense_rq;
246 struct ide_atapi_pc *pc = &drive->request_sense_pc;
248 (void)ide_read_error(drive);
249 ide_create_request_sense_cmd(drive, pc);
250 if (drive->media == ide_tape)
251 set_bit(IDE_AFLAG_IGNORE_DSC, &drive->atapi_flags);
252 ide_queue_pc_head(drive, disk, pc, rq);
254 EXPORT_SYMBOL_GPL(ide_retry_pc);
256 int ide_cd_expiry(ide_drive_t *drive)
258 struct request *rq = drive->hwif->rq;
259 unsigned long wait = 0;
261 debug_log("%s: rq->cmd[0]: 0x%x\n", __func__, rq->cmd[0]);
264 * Some commands are *slow* and normally take a long time to complete.
265 * Usually we can use the ATAPI "disconnect" to bypass this, but not all
266 * commands/drives support that. Let ide_timer_expiry keep polling us
269 switch (rq->cmd[0]) {
271 case GPCMD_FORMAT_UNIT:
272 case GPCMD_RESERVE_RZONE_TRACK:
273 case GPCMD_CLOSE_TRACK:
274 case GPCMD_FLUSH_CACHE:
275 wait = ATAPI_WAIT_PC;
278 if (!(rq->cmd_flags & REQ_QUIET))
279 printk(KERN_INFO "cmd 0x%x timed out\n",
286 EXPORT_SYMBOL_GPL(ide_cd_expiry);
288 int ide_cd_get_xferlen(struct request *rq)
290 if (blk_fs_request(rq))
292 else if (blk_sense_request(rq) || blk_pc_request(rq) ||
293 rq->cmd_type == REQ_TYPE_ATA_PC)
298 EXPORT_SYMBOL_GPL(ide_cd_get_xferlen);
301 * This is the usual interrupt handler which will be called during a packet
302 * command. We will transfer some of the data (as requested by the drive)
303 * and will re-point interrupt handler to us.
305 static ide_startstop_t ide_pc_intr(ide_drive_t *drive)
307 struct ide_atapi_pc *pc = drive->pc;
308 ide_hwif_t *hwif = drive->hwif;
309 struct request *rq = hwif->rq;
310 const struct ide_tp_ops *tp_ops = hwif->tp_ops;
311 xfer_func_t *xferfunc;
312 unsigned int timeout, temp;
314 u8 stat, ireason, dsc = 0;
316 debug_log("Enter %s - interrupt handler\n", __func__);
318 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
321 if (pc->flags & PC_FLAG_TIMEDOUT) {
322 drive->pc_callback(drive, 0);
326 /* Clear the interrupt */
327 stat = tp_ops->read_status(hwif);
329 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
330 if (hwif->dma_ops->dma_end(drive) ||
331 (drive->media == ide_tape && (stat & ATA_ERR))) {
332 if (drive->media == ide_floppy)
333 printk(KERN_ERR "%s: DMA %s error\n",
334 drive->name, rq_data_dir(pc->rq)
336 pc->flags |= PC_FLAG_DMA_ERROR;
338 pc->xferred = pc->req_xfer;
339 if (drive->pc_update_buffers)
340 drive->pc_update_buffers(drive, pc);
342 debug_log("%s: DMA finished\n", drive->name);
345 /* No more interrupts */
346 if ((stat & ATA_DRQ) == 0) {
347 debug_log("Packet command completed, %d bytes transferred\n",
350 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
352 local_irq_enable_in_hardirq();
354 if (drive->media == ide_tape &&
355 (stat & ATA_ERR) && rq->cmd[0] == REQUEST_SENSE)
358 if ((stat & ATA_ERR) || (pc->flags & PC_FLAG_DMA_ERROR)) {
360 debug_log("%s: I/O error\n", drive->name);
362 if (drive->media != ide_tape)
365 if (rq->cmd[0] == REQUEST_SENSE) {
366 printk(KERN_ERR "%s: I/O error in request sense"
367 " command\n", drive->name);
368 return ide_do_reset(drive);
371 debug_log("[cmd %x]: check condition\n", rq->cmd[0]);
373 /* Retry operation */
374 ide_retry_pc(drive, rq->rq_disk);
376 /* queued, but not started */
381 if ((pc->flags & PC_FLAG_WAIT_FOR_DSC) && (stat & ATA_DSC) == 0)
384 /* Command finished - Call the callback function */
385 drive->pc_callback(drive, dsc);
390 if (pc->flags & PC_FLAG_DMA_IN_PROGRESS) {
391 pc->flags &= ~PC_FLAG_DMA_IN_PROGRESS;
392 printk(KERN_ERR "%s: The device wants to issue more interrupts "
393 "in DMA mode\n", drive->name);
395 return ide_do_reset(drive);
398 /* Get the number of bytes to transfer on this interrupt. */
399 ide_read_bcount_and_ireason(drive, &bcount, &ireason);
401 if (ireason & ATAPI_COD) {
402 printk(KERN_ERR "%s: CoD != 0 in %s\n", drive->name, __func__);
403 return ide_do_reset(drive);
406 if (((ireason & ATAPI_IO) == ATAPI_IO) ==
407 !!(pc->flags & PC_FLAG_WRITING)) {
408 /* Hopefully, we will never get here */
409 printk(KERN_ERR "%s: We wanted to %s, but the device wants us "
410 "to %s!\n", drive->name,
411 (ireason & ATAPI_IO) ? "Write" : "Read",
412 (ireason & ATAPI_IO) ? "Read" : "Write");
413 return ide_do_reset(drive);
416 if (!(pc->flags & PC_FLAG_WRITING)) {
417 /* Reading - Check that we have enough space */
418 temp = pc->xferred + bcount;
419 if (temp > pc->req_xfer) {
420 if (temp > pc->buf_size) {
421 printk(KERN_ERR "%s: The device wants to send "
422 "us more data than expected - "
426 ide_pad_transfer(drive, 0, bcount);
429 debug_log("The device wants to send us more data than "
430 "expected - allowing transfer\n");
432 xferfunc = tp_ops->input_data;
434 xferfunc = tp_ops->output_data;
436 if ((drive->media == ide_floppy && !pc->buf) ||
437 (drive->media == ide_tape && pc->bh)) {
438 int done = drive->pc_io_buffers(drive, pc, bcount,
439 !!(pc->flags & PC_FLAG_WRITING));
441 /* FIXME: don't do partial completions */
442 if (drive->media == ide_floppy)
443 ide_end_request(drive, 1, done >> 9);
445 xferfunc(drive, NULL, pc->cur_pos, bcount);
447 /* Update the current position */
448 pc->xferred += bcount;
449 pc->cur_pos += bcount;
451 debug_log("[cmd %x] transferred %d bytes on that intr.\n",
454 /* And set the interrupt handler again */
455 ide_set_handler(drive, ide_pc_intr, timeout, NULL);
459 static u8 ide_read_ireason(ide_drive_t *drive)
463 memset(&task, 0, sizeof(task));
464 task.tf_flags = IDE_TFLAG_IN_NSECT;
466 drive->hwif->tp_ops->tf_read(drive, &task);
468 return task.tf.nsect & 3;
471 static u8 ide_wait_ireason(ide_drive_t *drive, u8 ireason)
475 while (retries-- && ((ireason & ATAPI_COD) == 0 ||
476 (ireason & ATAPI_IO))) {
477 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
478 "a packet command, retrying\n", drive->name);
480 ireason = ide_read_ireason(drive);
482 printk(KERN_ERR "%s: (IO,CoD != (0,1) while issuing "
483 "a packet command, ignoring\n",
485 ireason |= ATAPI_COD;
486 ireason &= ~ATAPI_IO;
493 static int ide_delayed_transfer_pc(ide_drive_t *drive)
495 /* Send the actual packet */
496 drive->hwif->tp_ops->output_data(drive, NULL, drive->pc->c, 12);
498 /* Timeout for the packet command */
499 return WAIT_FLOPPY_CMD;
502 static ide_startstop_t ide_transfer_pc(ide_drive_t *drive)
504 struct ide_atapi_pc *uninitialized_var(pc);
505 ide_hwif_t *hwif = drive->hwif;
506 struct request *rq = hwif->rq;
507 ide_expiry_t *expiry;
508 unsigned int timeout;
510 ide_startstop_t startstop;
513 if (ide_wait_stat(&startstop, drive, ATA_DRQ, ATA_BUSY, WAIT_READY)) {
514 printk(KERN_ERR "%s: Strange, packet command initiated yet "
515 "DRQ isn't asserted\n", drive->name);
519 if (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT) {
521 drive->waiting_for_dma = 1;
524 if (dev_is_idecd(drive)) {
525 /* ATAPI commands get padded out to 12 bytes minimum */
526 cmd_len = COMMAND_SIZE(rq->cmd[0]);
527 if (cmd_len < ATAPI_MIN_CDB_BYTES)
528 cmd_len = ATAPI_MIN_CDB_BYTES;
530 timeout = rq->timeout;
531 expiry = ide_cd_expiry;
535 cmd_len = ATAPI_MIN_CDB_BYTES;
538 * If necessary schedule the packet transfer to occur 'timeout'
539 * miliseconds later in ide_delayed_transfer_pc() after the
540 * device says it's ready for a packet.
542 if (drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) {
543 timeout = drive->pc_delay;
544 expiry = &ide_delayed_transfer_pc;
546 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
551 ireason = ide_read_ireason(drive);
552 if (drive->media == ide_tape)
553 ireason = ide_wait_ireason(drive, ireason);
555 if ((ireason & ATAPI_COD) == 0 || (ireason & ATAPI_IO)) {
556 printk(KERN_ERR "%s: (IO,CoD) != (0,1) while issuing "
557 "a packet command\n", drive->name);
559 return ide_do_reset(drive);
563 /* Set the interrupt routine */
564 ide_set_handler(drive,
565 (dev_is_idecd(drive) ? drive->irq_handler
569 /* Begin DMA, if necessary */
570 if (dev_is_idecd(drive)) {
572 hwif->dma_ops->dma_start(drive);
574 if (pc->flags & PC_FLAG_DMA_OK) {
575 pc->flags |= PC_FLAG_DMA_IN_PROGRESS;
576 hwif->dma_ops->dma_start(drive);
580 /* Send the actual packet */
581 if ((drive->atapi_flags & IDE_AFLAG_ZIP_DRIVE) == 0)
582 hwif->tp_ops->output_data(drive, NULL, rq->cmd, cmd_len);
587 ide_startstop_t ide_issue_pc(ide_drive_t *drive)
589 struct ide_atapi_pc *pc;
590 ide_hwif_t *hwif = drive->hwif;
591 ide_expiry_t *expiry = NULL;
592 unsigned int timeout;
596 if (dev_is_idecd(drive)) {
597 tf_flags = IDE_TFLAG_OUT_NSECT | IDE_TFLAG_OUT_LBAL;
598 bcount = ide_cd_get_xferlen(hwif->rq);
599 expiry = ide_cd_expiry;
600 timeout = ATAPI_WAIT_PC;
603 drive->dma = !hwif->dma_ops->dma_setup(drive);
607 /* We haven't transferred any data yet */
609 pc->cur_pos = pc->buf;
611 tf_flags = IDE_TFLAG_OUT_DEVICE;
612 bcount = ((drive->media == ide_tape) ?
614 min(pc->req_xfer, 63 * 1024));
616 if (pc->flags & PC_FLAG_DMA_ERROR) {
617 pc->flags &= ~PC_FLAG_DMA_ERROR;
621 if ((pc->flags & PC_FLAG_DMA_OK) &&
622 (drive->dev_flags & IDE_DFLAG_USING_DMA))
623 drive->dma = !hwif->dma_ops->dma_setup(drive);
626 pc->flags &= ~PC_FLAG_DMA_OK;
628 timeout = (drive->media == ide_floppy) ? WAIT_FLOPPY_CMD
632 ide_pktcmd_tf_load(drive, tf_flags, bcount, drive->dma);
634 /* Issue the packet command */
635 if (drive->atapi_flags & IDE_AFLAG_DRQ_INTERRUPT) {
637 drive->waiting_for_dma = 0;
638 ide_execute_command(drive, ATA_CMD_PACKET, ide_transfer_pc,
642 ide_execute_pkt_cmd(drive);
643 return ide_transfer_pc(drive);
646 EXPORT_SYMBOL_GPL(ide_issue_pc);