libata: update DMA blacklist
[linux-2.6/linux-2.6-openrd.git] / drivers / scsi / libata-core.c
blobfd66f56fd612404b2b82669d9b8e716ef084df39
1 /*
2 libata-core.c - helper library for ATA
4 Copyright 2003-2004 Red Hat, Inc. All rights reserved.
5 Copyright 2003-2004 Jeff Garzik
7 The contents of this file are subject to the Open
8 Software License version 1.1 that can be found at
9 http://www.opensource.org/licenses/osl-1.1.txt and is included herein
10 by reference.
12 Alternatively, the contents of this file may be used under the terms
13 of the GNU General Public License version 2 (the "GPL") as distributed
14 in the kernel source COPYING file, in which case the provisions of
15 the GPL are applicable instead of the above. If you wish to allow
16 the use of your version of this file only under the terms of the
17 GPL and not to allow others to use your version of this file under
18 the OSL, indicate your decision by deleting the provisions above and
19 replace them with the notice and other provisions required by the GPL.
20 If you do not delete the provisions above, a recipient may use your
21 version of this file under either the OSL or the GPL.
25 #include <linux/config.h>
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/pci.h>
29 #include <linux/init.h>
30 #include <linux/list.h>
31 #include <linux/mm.h>
32 #include <linux/highmem.h>
33 #include <linux/spinlock.h>
34 #include <linux/blkdev.h>
35 #include <linux/delay.h>
36 #include <linux/timer.h>
37 #include <linux/interrupt.h>
38 #include <linux/completion.h>
39 #include <linux/suspend.h>
40 #include <linux/workqueue.h>
41 #include <scsi/scsi.h>
42 #include "scsi.h"
43 #include "scsi_priv.h"
44 #include <scsi/scsi_host.h>
45 #include <linux/libata.h>
46 #include <asm/io.h>
47 #include <asm/semaphore.h>
48 #include <asm/byteorder.h>
50 #include "libata.h"
52 static unsigned int ata_busy_sleep (struct ata_port *ap,
53 unsigned long tmout_pat,
54 unsigned long tmout);
55 static void ata_set_mode(struct ata_port *ap);
56 static void ata_dev_set_xfermode(struct ata_port *ap, struct ata_device *dev);
57 static unsigned int ata_get_mode_mask(struct ata_port *ap, int shift);
58 static int fgb(u32 bitmap);
59 static int ata_choose_xfer_mode(struct ata_port *ap,
60 u8 *xfer_mode_out,
61 unsigned int *xfer_shift_out);
62 static int ata_qc_complete_noop(struct ata_queued_cmd *qc, u8 drv_stat);
63 static void __ata_qc_complete(struct ata_queued_cmd *qc);
65 static unsigned int ata_unique_id = 1;
66 static struct workqueue_struct *ata_wq;
68 MODULE_AUTHOR("Jeff Garzik");
69 MODULE_DESCRIPTION("Library module for ATA devices");
70 MODULE_LICENSE("GPL");
71 MODULE_VERSION(DRV_VERSION);
73 /**
74 * ata_tf_load - send taskfile registers to host controller
75 * @ap: Port to which output is sent
76 * @tf: ATA taskfile register set
78 * Outputs ATA taskfile to standard ATA host controller.
80 * LOCKING:
81 * Inherited from caller.
84 static void ata_tf_load_pio(struct ata_port *ap, struct ata_taskfile *tf)
86 struct ata_ioports *ioaddr = &ap->ioaddr;
87 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
89 if (tf->ctl != ap->last_ctl) {
90 outb(tf->ctl, ioaddr->ctl_addr);
91 ap->last_ctl = tf->ctl;
92 ata_wait_idle(ap);
95 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
96 outb(tf->hob_feature, ioaddr->feature_addr);
97 outb(tf->hob_nsect, ioaddr->nsect_addr);
98 outb(tf->hob_lbal, ioaddr->lbal_addr);
99 outb(tf->hob_lbam, ioaddr->lbam_addr);
100 outb(tf->hob_lbah, ioaddr->lbah_addr);
101 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
102 tf->hob_feature,
103 tf->hob_nsect,
104 tf->hob_lbal,
105 tf->hob_lbam,
106 tf->hob_lbah);
109 if (is_addr) {
110 outb(tf->feature, ioaddr->feature_addr);
111 outb(tf->nsect, ioaddr->nsect_addr);
112 outb(tf->lbal, ioaddr->lbal_addr);
113 outb(tf->lbam, ioaddr->lbam_addr);
114 outb(tf->lbah, ioaddr->lbah_addr);
115 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
116 tf->feature,
117 tf->nsect,
118 tf->lbal,
119 tf->lbam,
120 tf->lbah);
123 if (tf->flags & ATA_TFLAG_DEVICE) {
124 outb(tf->device, ioaddr->device_addr);
125 VPRINTK("device 0x%X\n", tf->device);
128 ata_wait_idle(ap);
132 * ata_tf_load_mmio - send taskfile registers to host controller
133 * @ap: Port to which output is sent
134 * @tf: ATA taskfile register set
136 * Outputs ATA taskfile to standard ATA host controller using MMIO.
138 * LOCKING:
139 * Inherited from caller.
142 static void ata_tf_load_mmio(struct ata_port *ap, struct ata_taskfile *tf)
144 struct ata_ioports *ioaddr = &ap->ioaddr;
145 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
147 if (tf->ctl != ap->last_ctl) {
148 writeb(tf->ctl, (void __iomem *) ap->ioaddr.ctl_addr);
149 ap->last_ctl = tf->ctl;
150 ata_wait_idle(ap);
153 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
154 writeb(tf->hob_feature, (void __iomem *) ioaddr->feature_addr);
155 writeb(tf->hob_nsect, (void __iomem *) ioaddr->nsect_addr);
156 writeb(tf->hob_lbal, (void __iomem *) ioaddr->lbal_addr);
157 writeb(tf->hob_lbam, (void __iomem *) ioaddr->lbam_addr);
158 writeb(tf->hob_lbah, (void __iomem *) ioaddr->lbah_addr);
159 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
160 tf->hob_feature,
161 tf->hob_nsect,
162 tf->hob_lbal,
163 tf->hob_lbam,
164 tf->hob_lbah);
167 if (is_addr) {
168 writeb(tf->feature, (void __iomem *) ioaddr->feature_addr);
169 writeb(tf->nsect, (void __iomem *) ioaddr->nsect_addr);
170 writeb(tf->lbal, (void __iomem *) ioaddr->lbal_addr);
171 writeb(tf->lbam, (void __iomem *) ioaddr->lbam_addr);
172 writeb(tf->lbah, (void __iomem *) ioaddr->lbah_addr);
173 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
174 tf->feature,
175 tf->nsect,
176 tf->lbal,
177 tf->lbam,
178 tf->lbah);
181 if (tf->flags & ATA_TFLAG_DEVICE) {
182 writeb(tf->device, (void __iomem *) ioaddr->device_addr);
183 VPRINTK("device 0x%X\n", tf->device);
186 ata_wait_idle(ap);
191 * ata_tf_load - send taskfile registers to host controller
192 * @ap: Port to which output is sent
193 * @tf: ATA taskfile register set
195 * Outputs ATA taskfile to standard ATA host controller using MMIO
196 * or PIO as indicated by the ATA_FLAG_MMIO flag.
197 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
198 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
199 * hob_lbal, hob_lbam, and hob_lbah.
201 * This function waits for idle (!BUSY and !DRQ) after writing
202 * registers. If the control register has a new value, this
203 * function also waits for idle after writing control and before
204 * writing the remaining registers.
206 * May be used as the tf_load() entry in ata_port_operations.
208 * LOCKING:
209 * Inherited from caller.
211 void ata_tf_load(struct ata_port *ap, struct ata_taskfile *tf)
213 if (ap->flags & ATA_FLAG_MMIO)
214 ata_tf_load_mmio(ap, tf);
215 else
216 ata_tf_load_pio(ap, tf);
220 * ata_exec_command_pio - issue ATA command to host controller
221 * @ap: port to which command is being issued
222 * @tf: ATA taskfile register set
224 * Issues PIO write to ATA command register, with proper
225 * synchronization with interrupt handler / other threads.
227 * LOCKING:
228 * spin_lock_irqsave(host_set lock)
231 static void ata_exec_command_pio(struct ata_port *ap, struct ata_taskfile *tf)
233 DPRINTK("ata%u: cmd 0x%X\n", ap->id, tf->command);
235 outb(tf->command, ap->ioaddr.command_addr);
236 ata_pause(ap);
241 * ata_exec_command_mmio - issue ATA command to host controller
242 * @ap: port to which command is being issued
243 * @tf: ATA taskfile register set
245 * Issues MMIO write to ATA command register, with proper
246 * synchronization with interrupt handler / other threads.
248 * LOCKING:
249 * spin_lock_irqsave(host_set lock)
252 static void ata_exec_command_mmio(struct ata_port *ap, struct ata_taskfile *tf)
254 DPRINTK("ata%u: cmd 0x%X\n", ap->id, tf->command);
256 writeb(tf->command, (void __iomem *) ap->ioaddr.command_addr);
257 ata_pause(ap);
262 * ata_exec_command - issue ATA command to host controller
263 * @ap: port to which command is being issued
264 * @tf: ATA taskfile register set
266 * Issues PIO/MMIO write to ATA command register, with proper
267 * synchronization with interrupt handler / other threads.
269 * LOCKING:
270 * spin_lock_irqsave(host_set lock)
272 void ata_exec_command(struct ata_port *ap, struct ata_taskfile *tf)
274 if (ap->flags & ATA_FLAG_MMIO)
275 ata_exec_command_mmio(ap, tf);
276 else
277 ata_exec_command_pio(ap, tf);
281 * ata_exec - issue ATA command to host controller
282 * @ap: port to which command is being issued
283 * @tf: ATA taskfile register set
285 * Issues PIO/MMIO write to ATA command register, with proper
286 * synchronization with interrupt handler / other threads.
288 * LOCKING:
289 * Obtains host_set lock.
292 static inline void ata_exec(struct ata_port *ap, struct ata_taskfile *tf)
294 unsigned long flags;
296 DPRINTK("ata%u: cmd 0x%X\n", ap->id, tf->command);
297 spin_lock_irqsave(&ap->host_set->lock, flags);
298 ap->ops->exec_command(ap, tf);
299 spin_unlock_irqrestore(&ap->host_set->lock, flags);
303 * ata_tf_to_host - issue ATA taskfile to host controller
304 * @ap: port to which command is being issued
305 * @tf: ATA taskfile register set
307 * Issues ATA taskfile register set to ATA host controller,
308 * with proper synchronization with interrupt handler and
309 * other threads.
311 * LOCKING:
312 * Obtains host_set lock.
315 static void ata_tf_to_host(struct ata_port *ap, struct ata_taskfile *tf)
317 ap->ops->tf_load(ap, tf);
319 ata_exec(ap, tf);
323 * ata_tf_to_host_nolock - issue ATA taskfile to host controller
324 * @ap: port to which command is being issued
325 * @tf: ATA taskfile register set
327 * Issues ATA taskfile register set to ATA host controller,
328 * with proper synchronization with interrupt handler and
329 * other threads.
331 * LOCKING:
332 * spin_lock_irqsave(host_set lock)
335 void ata_tf_to_host_nolock(struct ata_port *ap, struct ata_taskfile *tf)
337 ap->ops->tf_load(ap, tf);
338 ap->ops->exec_command(ap, tf);
342 * ata_tf_read_pio - input device's ATA taskfile shadow registers
343 * @ap: Port from which input is read
344 * @tf: ATA taskfile register set for storing input
346 * Reads ATA taskfile registers for currently-selected device
347 * into @tf.
349 * LOCKING:
350 * Inherited from caller.
353 static void ata_tf_read_pio(struct ata_port *ap, struct ata_taskfile *tf)
355 struct ata_ioports *ioaddr = &ap->ioaddr;
357 tf->nsect = inb(ioaddr->nsect_addr);
358 tf->lbal = inb(ioaddr->lbal_addr);
359 tf->lbam = inb(ioaddr->lbam_addr);
360 tf->lbah = inb(ioaddr->lbah_addr);
361 tf->device = inb(ioaddr->device_addr);
363 if (tf->flags & ATA_TFLAG_LBA48) {
364 outb(tf->ctl | ATA_HOB, ioaddr->ctl_addr);
365 tf->hob_feature = inb(ioaddr->error_addr);
366 tf->hob_nsect = inb(ioaddr->nsect_addr);
367 tf->hob_lbal = inb(ioaddr->lbal_addr);
368 tf->hob_lbam = inb(ioaddr->lbam_addr);
369 tf->hob_lbah = inb(ioaddr->lbah_addr);
374 * ata_tf_read_mmio - input device's ATA taskfile shadow registers
375 * @ap: Port from which input is read
376 * @tf: ATA taskfile register set for storing input
378 * Reads ATA taskfile registers for currently-selected device
379 * into @tf via MMIO.
381 * LOCKING:
382 * Inherited from caller.
385 static void ata_tf_read_mmio(struct ata_port *ap, struct ata_taskfile *tf)
387 struct ata_ioports *ioaddr = &ap->ioaddr;
389 tf->nsect = readb((void __iomem *)ioaddr->nsect_addr);
390 tf->lbal = readb((void __iomem *)ioaddr->lbal_addr);
391 tf->lbam = readb((void __iomem *)ioaddr->lbam_addr);
392 tf->lbah = readb((void __iomem *)ioaddr->lbah_addr);
393 tf->device = readb((void __iomem *)ioaddr->device_addr);
395 if (tf->flags & ATA_TFLAG_LBA48) {
396 writeb(tf->ctl | ATA_HOB, (void __iomem *) ap->ioaddr.ctl_addr);
397 tf->hob_feature = readb((void __iomem *)ioaddr->error_addr);
398 tf->hob_nsect = readb((void __iomem *)ioaddr->nsect_addr);
399 tf->hob_lbal = readb((void __iomem *)ioaddr->lbal_addr);
400 tf->hob_lbam = readb((void __iomem *)ioaddr->lbam_addr);
401 tf->hob_lbah = readb((void __iomem *)ioaddr->lbah_addr);
407 * ata_tf_read - input device's ATA taskfile shadow registers
408 * @ap: Port from which input is read
409 * @tf: ATA taskfile register set for storing input
411 * Reads ATA taskfile registers for currently-selected device
412 * into @tf.
414 * Reads nsect, lbal, lbam, lbah, and device. If ATA_TFLAG_LBA48
415 * is set, also reads the hob registers.
417 * May be used as the tf_read() entry in ata_port_operations.
419 * LOCKING:
420 * Inherited from caller.
422 void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
424 if (ap->flags & ATA_FLAG_MMIO)
425 ata_tf_read_mmio(ap, tf);
426 else
427 ata_tf_read_pio(ap, tf);
431 * ata_check_status_pio - Read device status reg & clear interrupt
432 * @ap: port where the device is
434 * Reads ATA taskfile status register for currently-selected device
435 * and return its value. This also clears pending interrupts
436 * from this device
438 * LOCKING:
439 * Inherited from caller.
441 static u8 ata_check_status_pio(struct ata_port *ap)
443 return inb(ap->ioaddr.status_addr);
447 * ata_check_status_mmio - Read device status reg & clear interrupt
448 * @ap: port where the device is
450 * Reads ATA taskfile status register for currently-selected device
451 * via MMIO and return its value. This also clears pending interrupts
452 * from this device
454 * LOCKING:
455 * Inherited from caller.
457 static u8 ata_check_status_mmio(struct ata_port *ap)
459 return readb((void __iomem *) ap->ioaddr.status_addr);
464 * ata_check_status - Read device status reg & clear interrupt
465 * @ap: port where the device is
467 * Reads ATA taskfile status register for currently-selected device
468 * and return its value. This also clears pending interrupts
469 * from this device
471 * May be used as the check_status() entry in ata_port_operations.
473 * LOCKING:
474 * Inherited from caller.
476 u8 ata_check_status(struct ata_port *ap)
478 if (ap->flags & ATA_FLAG_MMIO)
479 return ata_check_status_mmio(ap);
480 return ata_check_status_pio(ap);
485 * ata_altstatus - Read device alternate status reg
486 * @ap: port where the device is
488 * Reads ATA taskfile alternate status register for
489 * currently-selected device and return its value.
491 * Note: may NOT be used as the check_altstatus() entry in
492 * ata_port_operations.
494 * LOCKING:
495 * Inherited from caller.
497 u8 ata_altstatus(struct ata_port *ap)
499 if (ap->ops->check_altstatus)
500 return ap->ops->check_altstatus(ap);
502 if (ap->flags & ATA_FLAG_MMIO)
503 return readb((void __iomem *)ap->ioaddr.altstatus_addr);
504 return inb(ap->ioaddr.altstatus_addr);
509 * ata_chk_err - Read device error reg
510 * @ap: port where the device is
512 * Reads ATA taskfile error register for
513 * currently-selected device and return its value.
515 * Note: may NOT be used as the check_err() entry in
516 * ata_port_operations.
518 * LOCKING:
519 * Inherited from caller.
521 u8 ata_chk_err(struct ata_port *ap)
523 if (ap->ops->check_err)
524 return ap->ops->check_err(ap);
526 if (ap->flags & ATA_FLAG_MMIO) {
527 return readb((void __iomem *) ap->ioaddr.error_addr);
529 return inb(ap->ioaddr.error_addr);
533 * ata_tf_to_fis - Convert ATA taskfile to SATA FIS structure
534 * @tf: Taskfile to convert
535 * @fis: Buffer into which data will output
536 * @pmp: Port multiplier port
538 * Converts a standard ATA taskfile to a Serial ATA
539 * FIS structure (Register - Host to Device).
541 * LOCKING:
542 * Inherited from caller.
545 void ata_tf_to_fis(struct ata_taskfile *tf, u8 *fis, u8 pmp)
547 fis[0] = 0x27; /* Register - Host to Device FIS */
548 fis[1] = (pmp & 0xf) | (1 << 7); /* Port multiplier number,
549 bit 7 indicates Command FIS */
550 fis[2] = tf->command;
551 fis[3] = tf->feature;
553 fis[4] = tf->lbal;
554 fis[5] = tf->lbam;
555 fis[6] = tf->lbah;
556 fis[7] = tf->device;
558 fis[8] = tf->hob_lbal;
559 fis[9] = tf->hob_lbam;
560 fis[10] = tf->hob_lbah;
561 fis[11] = tf->hob_feature;
563 fis[12] = tf->nsect;
564 fis[13] = tf->hob_nsect;
565 fis[14] = 0;
566 fis[15] = tf->ctl;
568 fis[16] = 0;
569 fis[17] = 0;
570 fis[18] = 0;
571 fis[19] = 0;
575 * ata_tf_from_fis - Convert SATA FIS to ATA taskfile
576 * @fis: Buffer from which data will be input
577 * @tf: Taskfile to output
579 * Converts a standard ATA taskfile to a Serial ATA
580 * FIS structure (Register - Host to Device).
582 * LOCKING:
583 * Inherited from caller.
586 void ata_tf_from_fis(u8 *fis, struct ata_taskfile *tf)
588 tf->command = fis[2]; /* status */
589 tf->feature = fis[3]; /* error */
591 tf->lbal = fis[4];
592 tf->lbam = fis[5];
593 tf->lbah = fis[6];
594 tf->device = fis[7];
596 tf->hob_lbal = fis[8];
597 tf->hob_lbam = fis[9];
598 tf->hob_lbah = fis[10];
600 tf->nsect = fis[12];
601 tf->hob_nsect = fis[13];
605 * ata_prot_to_cmd - determine which read/write opcodes to use
606 * @protocol: ATA_PROT_xxx taskfile protocol
607 * @lba48: true is lba48 is present
609 * Given necessary input, determine which read/write commands
610 * to use to transfer data.
612 * LOCKING:
613 * None.
615 static int ata_prot_to_cmd(int protocol, int lba48)
617 int rcmd = 0, wcmd = 0;
619 switch (protocol) {
620 case ATA_PROT_PIO:
621 if (lba48) {
622 rcmd = ATA_CMD_PIO_READ_EXT;
623 wcmd = ATA_CMD_PIO_WRITE_EXT;
624 } else {
625 rcmd = ATA_CMD_PIO_READ;
626 wcmd = ATA_CMD_PIO_WRITE;
628 break;
630 case ATA_PROT_DMA:
631 if (lba48) {
632 rcmd = ATA_CMD_READ_EXT;
633 wcmd = ATA_CMD_WRITE_EXT;
634 } else {
635 rcmd = ATA_CMD_READ;
636 wcmd = ATA_CMD_WRITE;
638 break;
640 default:
641 return -1;
644 return rcmd | (wcmd << 8);
648 * ata_dev_set_protocol - set taskfile protocol and r/w commands
649 * @dev: device to examine and configure
651 * Examine the device configuration, after we have
652 * read the identify-device page and configured the
653 * data transfer mode. Set internal state related to
654 * the ATA taskfile protocol (pio, pio mult, dma, etc.)
655 * and calculate the proper read/write commands to use.
657 * LOCKING:
658 * caller.
660 static void ata_dev_set_protocol(struct ata_device *dev)
662 int pio = (dev->flags & ATA_DFLAG_PIO);
663 int lba48 = (dev->flags & ATA_DFLAG_LBA48);
664 int proto, cmd;
666 if (pio)
667 proto = dev->xfer_protocol = ATA_PROT_PIO;
668 else
669 proto = dev->xfer_protocol = ATA_PROT_DMA;
671 cmd = ata_prot_to_cmd(proto, lba48);
672 if (cmd < 0)
673 BUG();
675 dev->read_cmd = cmd & 0xff;
676 dev->write_cmd = (cmd >> 8) & 0xff;
679 static const char * xfer_mode_str[] = {
680 "UDMA/16",
681 "UDMA/25",
682 "UDMA/33",
683 "UDMA/44",
684 "UDMA/66",
685 "UDMA/100",
686 "UDMA/133",
687 "UDMA7",
688 "MWDMA0",
689 "MWDMA1",
690 "MWDMA2",
691 "PIO0",
692 "PIO1",
693 "PIO2",
694 "PIO3",
695 "PIO4",
699 * ata_udma_string - convert UDMA bit offset to string
700 * @mask: mask of bits supported; only highest bit counts.
702 * Determine string which represents the highest speed
703 * (highest bit in @udma_mask).
705 * LOCKING:
706 * None.
708 * RETURNS:
709 * Constant C string representing highest speed listed in
710 * @udma_mask, or the constant C string "<n/a>".
713 static const char *ata_mode_string(unsigned int mask)
715 int i;
717 for (i = 7; i >= 0; i--)
718 if (mask & (1 << i))
719 goto out;
720 for (i = ATA_SHIFT_MWDMA + 2; i >= ATA_SHIFT_MWDMA; i--)
721 if (mask & (1 << i))
722 goto out;
723 for (i = ATA_SHIFT_PIO + 4; i >= ATA_SHIFT_PIO; i--)
724 if (mask & (1 << i))
725 goto out;
727 return "<n/a>";
729 out:
730 return xfer_mode_str[i];
734 * ata_pio_devchk - PATA device presence detection
735 * @ap: ATA channel to examine
736 * @device: Device to examine (starting at zero)
738 * This technique was originally described in
739 * Hale Landis's ATADRVR (www.ata-atapi.com), and
740 * later found its way into the ATA/ATAPI spec.
742 * Write a pattern to the ATA shadow registers,
743 * and if a device is present, it will respond by
744 * correctly storing and echoing back the
745 * ATA shadow register contents.
747 * LOCKING:
748 * caller.
751 static unsigned int ata_pio_devchk(struct ata_port *ap,
752 unsigned int device)
754 struct ata_ioports *ioaddr = &ap->ioaddr;
755 u8 nsect, lbal;
757 ap->ops->dev_select(ap, device);
759 outb(0x55, ioaddr->nsect_addr);
760 outb(0xaa, ioaddr->lbal_addr);
762 outb(0xaa, ioaddr->nsect_addr);
763 outb(0x55, ioaddr->lbal_addr);
765 outb(0x55, ioaddr->nsect_addr);
766 outb(0xaa, ioaddr->lbal_addr);
768 nsect = inb(ioaddr->nsect_addr);
769 lbal = inb(ioaddr->lbal_addr);
771 if ((nsect == 0x55) && (lbal == 0xaa))
772 return 1; /* we found a device */
774 return 0; /* nothing found */
778 * ata_mmio_devchk - PATA device presence detection
779 * @ap: ATA channel to examine
780 * @device: Device to examine (starting at zero)
782 * This technique was originally described in
783 * Hale Landis's ATADRVR (www.ata-atapi.com), and
784 * later found its way into the ATA/ATAPI spec.
786 * Write a pattern to the ATA shadow registers,
787 * and if a device is present, it will respond by
788 * correctly storing and echoing back the
789 * ATA shadow register contents.
791 * LOCKING:
792 * caller.
795 static unsigned int ata_mmio_devchk(struct ata_port *ap,
796 unsigned int device)
798 struct ata_ioports *ioaddr = &ap->ioaddr;
799 u8 nsect, lbal;
801 ap->ops->dev_select(ap, device);
803 writeb(0x55, (void __iomem *) ioaddr->nsect_addr);
804 writeb(0xaa, (void __iomem *) ioaddr->lbal_addr);
806 writeb(0xaa, (void __iomem *) ioaddr->nsect_addr);
807 writeb(0x55, (void __iomem *) ioaddr->lbal_addr);
809 writeb(0x55, (void __iomem *) ioaddr->nsect_addr);
810 writeb(0xaa, (void __iomem *) ioaddr->lbal_addr);
812 nsect = readb((void __iomem *) ioaddr->nsect_addr);
813 lbal = readb((void __iomem *) ioaddr->lbal_addr);
815 if ((nsect == 0x55) && (lbal == 0xaa))
816 return 1; /* we found a device */
818 return 0; /* nothing found */
822 * ata_devchk - PATA device presence detection
823 * @ap: ATA channel to examine
824 * @device: Device to examine (starting at zero)
826 * Dispatch ATA device presence detection, depending
827 * on whether we are using PIO or MMIO to talk to the
828 * ATA shadow registers.
830 * LOCKING:
831 * caller.
834 static unsigned int ata_devchk(struct ata_port *ap,
835 unsigned int device)
837 if (ap->flags & ATA_FLAG_MMIO)
838 return ata_mmio_devchk(ap, device);
839 return ata_pio_devchk(ap, device);
843 * ata_dev_classify - determine device type based on ATA-spec signature
844 * @tf: ATA taskfile register set for device to be identified
846 * Determine from taskfile register contents whether a device is
847 * ATA or ATAPI, as per "Signature and persistence" section
848 * of ATA/PI spec (volume 1, sect 5.14).
850 * LOCKING:
851 * None.
853 * RETURNS:
854 * Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, or %ATA_DEV_UNKNOWN
855 * the event of failure.
858 unsigned int ata_dev_classify(struct ata_taskfile *tf)
860 /* Apple's open source Darwin code hints that some devices only
861 * put a proper signature into the LBA mid/high registers,
862 * So, we only check those. It's sufficient for uniqueness.
865 if (((tf->lbam == 0) && (tf->lbah == 0)) ||
866 ((tf->lbam == 0x3c) && (tf->lbah == 0xc3))) {
867 DPRINTK("found ATA device by sig\n");
868 return ATA_DEV_ATA;
871 if (((tf->lbam == 0x14) && (tf->lbah == 0xeb)) ||
872 ((tf->lbam == 0x69) && (tf->lbah == 0x96))) {
873 DPRINTK("found ATAPI device by sig\n");
874 return ATA_DEV_ATAPI;
877 DPRINTK("unknown device\n");
878 return ATA_DEV_UNKNOWN;
882 * ata_dev_try_classify - Parse returned ATA device signature
883 * @ap: ATA channel to examine
884 * @device: Device to examine (starting at zero)
886 * After an event -- SRST, E.D.D., or SATA COMRESET -- occurs,
887 * an ATA/ATAPI-defined set of values is placed in the ATA
888 * shadow registers, indicating the results of device detection
889 * and diagnostics.
891 * Select the ATA device, and read the values from the ATA shadow
892 * registers. Then parse according to the Error register value,
893 * and the spec-defined values examined by ata_dev_classify().
895 * LOCKING:
896 * caller.
899 static u8 ata_dev_try_classify(struct ata_port *ap, unsigned int device)
901 struct ata_device *dev = &ap->device[device];
902 struct ata_taskfile tf;
903 unsigned int class;
904 u8 err;
906 ap->ops->dev_select(ap, device);
908 memset(&tf, 0, sizeof(tf));
910 err = ata_chk_err(ap);
911 ap->ops->tf_read(ap, &tf);
913 dev->class = ATA_DEV_NONE;
915 /* see if device passed diags */
916 if (err == 1)
917 /* do nothing */ ;
918 else if ((device == 0) && (err == 0x81))
919 /* do nothing */ ;
920 else
921 return err;
923 /* determine if device if ATA or ATAPI */
924 class = ata_dev_classify(&tf);
925 if (class == ATA_DEV_UNKNOWN)
926 return err;
927 if ((class == ATA_DEV_ATA) && (ata_chk_status(ap) == 0))
928 return err;
930 dev->class = class;
932 return err;
936 * ata_dev_id_string - Convert IDENTIFY DEVICE page into string
937 * @id: IDENTIFY DEVICE results we will examine
938 * @s: string into which data is output
939 * @ofs: offset into identify device page
940 * @len: length of string to return. must be an even number.
942 * The strings in the IDENTIFY DEVICE page are broken up into
943 * 16-bit chunks. Run through the string, and output each
944 * 8-bit chunk linearly, regardless of platform.
946 * LOCKING:
947 * caller.
950 void ata_dev_id_string(u16 *id, unsigned char *s,
951 unsigned int ofs, unsigned int len)
953 unsigned int c;
955 while (len > 0) {
956 c = id[ofs] >> 8;
957 *s = c;
958 s++;
960 c = id[ofs] & 0xff;
961 *s = c;
962 s++;
964 ofs++;
965 len -= 2;
971 * ata_noop_dev_select - Select device 0/1 on ATA bus
972 * @ap: ATA channel to manipulate
973 * @device: ATA device (numbered from zero) to select
975 * This function performs no actual function.
977 * May be used as the dev_select() entry in ata_port_operations.
979 * LOCKING:
980 * caller.
982 void ata_noop_dev_select (struct ata_port *ap, unsigned int device)
988 * ata_std_dev_select - Select device 0/1 on ATA bus
989 * @ap: ATA channel to manipulate
990 * @device: ATA device (numbered from zero) to select
992 * Use the method defined in the ATA specification to
993 * make either device 0, or device 1, active on the
994 * ATA channel. Works with both PIO and MMIO.
996 * May be used as the dev_select() entry in ata_port_operations.
998 * LOCKING:
999 * caller.
1002 void ata_std_dev_select (struct ata_port *ap, unsigned int device)
1004 u8 tmp;
1006 if (device == 0)
1007 tmp = ATA_DEVICE_OBS;
1008 else
1009 tmp = ATA_DEVICE_OBS | ATA_DEV1;
1011 if (ap->flags & ATA_FLAG_MMIO) {
1012 writeb(tmp, (void __iomem *) ap->ioaddr.device_addr);
1013 } else {
1014 outb(tmp, ap->ioaddr.device_addr);
1016 ata_pause(ap); /* needed; also flushes, for mmio */
1020 * ata_dev_select - Select device 0/1 on ATA bus
1021 * @ap: ATA channel to manipulate
1022 * @device: ATA device (numbered from zero) to select
1023 * @wait: non-zero to wait for Status register BSY bit to clear
1024 * @can_sleep: non-zero if context allows sleeping
1026 * Use the method defined in the ATA specification to
1027 * make either device 0, or device 1, active on the
1028 * ATA channel.
1030 * This is a high-level version of ata_std_dev_select(),
1031 * which additionally provides the services of inserting
1032 * the proper pauses and status polling, where needed.
1034 * LOCKING:
1035 * caller.
1038 void ata_dev_select(struct ata_port *ap, unsigned int device,
1039 unsigned int wait, unsigned int can_sleep)
1041 VPRINTK("ENTER, ata%u: device %u, wait %u\n",
1042 ap->id, device, wait);
1044 if (wait)
1045 ata_wait_idle(ap);
1047 ap->ops->dev_select(ap, device);
1049 if (wait) {
1050 if (can_sleep && ap->device[device].class == ATA_DEV_ATAPI)
1051 msleep(150);
1052 ata_wait_idle(ap);
1057 * ata_dump_id - IDENTIFY DEVICE info debugging output
1058 * @dev: Device whose IDENTIFY DEVICE page we will dump
1060 * Dump selected 16-bit words from a detected device's
1061 * IDENTIFY PAGE page.
1063 * LOCKING:
1064 * caller.
1067 static inline void ata_dump_id(struct ata_device *dev)
1069 DPRINTK("49==0x%04x "
1070 "53==0x%04x "
1071 "63==0x%04x "
1072 "64==0x%04x "
1073 "75==0x%04x \n",
1074 dev->id[49],
1075 dev->id[53],
1076 dev->id[63],
1077 dev->id[64],
1078 dev->id[75]);
1079 DPRINTK("80==0x%04x "
1080 "81==0x%04x "
1081 "82==0x%04x "
1082 "83==0x%04x "
1083 "84==0x%04x \n",
1084 dev->id[80],
1085 dev->id[81],
1086 dev->id[82],
1087 dev->id[83],
1088 dev->id[84]);
1089 DPRINTK("88==0x%04x "
1090 "93==0x%04x\n",
1091 dev->id[88],
1092 dev->id[93]);
1096 * ata_dev_identify - obtain IDENTIFY x DEVICE page
1097 * @ap: port on which device we wish to probe resides
1098 * @device: device bus address, starting at zero
1100 * Following bus reset, we issue the IDENTIFY [PACKET] DEVICE
1101 * command, and read back the 512-byte device information page.
1102 * The device information page is fed to us via the standard
1103 * PIO-IN protocol, but we hand-code it here. (TODO: investigate
1104 * using standard PIO-IN paths)
1106 * After reading the device information page, we use several
1107 * bits of information from it to initialize data structures
1108 * that will be used during the lifetime of the ata_device.
1109 * Other data from the info page is used to disqualify certain
1110 * older ATA devices we do not wish to support.
1112 * LOCKING:
1113 * Inherited from caller. Some functions called by this function
1114 * obtain the host_set lock.
1117 static void ata_dev_identify(struct ata_port *ap, unsigned int device)
1119 struct ata_device *dev = &ap->device[device];
1120 unsigned int i;
1121 u16 tmp;
1122 unsigned long xfer_modes;
1123 u8 status;
1124 unsigned int using_edd;
1125 DECLARE_COMPLETION(wait);
1126 struct ata_queued_cmd *qc;
1127 unsigned long flags;
1128 int rc;
1130 if (!ata_dev_present(dev)) {
1131 DPRINTK("ENTER/EXIT (host %u, dev %u) -- nodev\n",
1132 ap->id, device);
1133 return;
1136 if (ap->flags & (ATA_FLAG_SRST | ATA_FLAG_SATA_RESET))
1137 using_edd = 0;
1138 else
1139 using_edd = 1;
1141 DPRINTK("ENTER, host %u, dev %u\n", ap->id, device);
1143 assert (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ATAPI ||
1144 dev->class == ATA_DEV_NONE);
1146 ata_dev_select(ap, device, 1, 1); /* select device 0/1 */
1148 qc = ata_qc_new_init(ap, dev);
1149 BUG_ON(qc == NULL);
1151 ata_sg_init_one(qc, dev->id, sizeof(dev->id));
1152 qc->dma_dir = DMA_FROM_DEVICE;
1153 qc->tf.protocol = ATA_PROT_PIO;
1154 qc->nsect = 1;
1156 retry:
1157 if (dev->class == ATA_DEV_ATA) {
1158 qc->tf.command = ATA_CMD_ID_ATA;
1159 DPRINTK("do ATA identify\n");
1160 } else {
1161 qc->tf.command = ATA_CMD_ID_ATAPI;
1162 DPRINTK("do ATAPI identify\n");
1165 qc->waiting = &wait;
1166 qc->complete_fn = ata_qc_complete_noop;
1168 spin_lock_irqsave(&ap->host_set->lock, flags);
1169 rc = ata_qc_issue(qc);
1170 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1172 if (rc)
1173 goto err_out;
1174 else
1175 wait_for_completion(&wait);
1177 status = ata_chk_status(ap);
1178 if (status & ATA_ERR) {
1180 * arg! EDD works for all test cases, but seems to return
1181 * the ATA signature for some ATAPI devices. Until the
1182 * reason for this is found and fixed, we fix up the mess
1183 * here. If IDENTIFY DEVICE returns command aborted
1184 * (as ATAPI devices do), then we issue an
1185 * IDENTIFY PACKET DEVICE.
1187 * ATA software reset (SRST, the default) does not appear
1188 * to have this problem.
1190 if ((using_edd) && (qc->tf.command == ATA_CMD_ID_ATA)) {
1191 u8 err = ata_chk_err(ap);
1192 if (err & ATA_ABORTED) {
1193 dev->class = ATA_DEV_ATAPI;
1194 qc->cursg = 0;
1195 qc->cursg_ofs = 0;
1196 qc->cursect = 0;
1197 qc->nsect = 1;
1198 goto retry;
1201 goto err_out;
1204 swap_buf_le16(dev->id, ATA_ID_WORDS);
1206 /* print device capabilities */
1207 printk(KERN_DEBUG "ata%u: dev %u cfg "
1208 "49:%04x 82:%04x 83:%04x 84:%04x 85:%04x 86:%04x 87:%04x 88:%04x\n",
1209 ap->id, device, dev->id[49],
1210 dev->id[82], dev->id[83], dev->id[84],
1211 dev->id[85], dev->id[86], dev->id[87],
1212 dev->id[88]);
1215 * common ATA, ATAPI feature tests
1218 /* we require LBA and DMA support (bits 8 & 9 of word 49) */
1219 if (!ata_id_has_dma(dev->id) || !ata_id_has_lba(dev->id)) {
1220 printk(KERN_DEBUG "ata%u: no dma/lba\n", ap->id);
1221 goto err_out_nosup;
1224 /* quick-n-dirty find max transfer mode; for printk only */
1225 xfer_modes = dev->id[ATA_ID_UDMA_MODES];
1226 if (!xfer_modes)
1227 xfer_modes = (dev->id[ATA_ID_MWDMA_MODES]) << ATA_SHIFT_MWDMA;
1228 if (!xfer_modes) {
1229 xfer_modes = (dev->id[ATA_ID_PIO_MODES]) << (ATA_SHIFT_PIO + 3);
1230 xfer_modes |= (0x7 << ATA_SHIFT_PIO);
1233 ata_dump_id(dev);
1235 /* ATA-specific feature tests */
1236 if (dev->class == ATA_DEV_ATA) {
1237 if (!ata_id_is_ata(dev->id)) /* sanity check */
1238 goto err_out_nosup;
1240 tmp = dev->id[ATA_ID_MAJOR_VER];
1241 for (i = 14; i >= 1; i--)
1242 if (tmp & (1 << i))
1243 break;
1245 /* we require at least ATA-3 */
1246 if (i < 3) {
1247 printk(KERN_DEBUG "ata%u: no ATA-3\n", ap->id);
1248 goto err_out_nosup;
1251 if (ata_id_has_lba48(dev->id)) {
1252 dev->flags |= ATA_DFLAG_LBA48;
1253 dev->n_sectors = ata_id_u64(dev->id, 100);
1254 } else {
1255 dev->n_sectors = ata_id_u32(dev->id, 60);
1258 ap->host->max_cmd_len = 16;
1260 /* print device info to dmesg */
1261 printk(KERN_INFO "ata%u: dev %u ATA, max %s, %Lu sectors:%s\n",
1262 ap->id, device,
1263 ata_mode_string(xfer_modes),
1264 (unsigned long long)dev->n_sectors,
1265 dev->flags & ATA_DFLAG_LBA48 ? " lba48" : "");
1268 /* ATAPI-specific feature tests */
1269 else {
1270 if (ata_id_is_ata(dev->id)) /* sanity check */
1271 goto err_out_nosup;
1273 rc = atapi_cdb_len(dev->id);
1274 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
1275 printk(KERN_WARNING "ata%u: unsupported CDB len\n", ap->id);
1276 goto err_out_nosup;
1278 ap->cdb_len = (unsigned int) rc;
1279 ap->host->max_cmd_len = (unsigned char) ap->cdb_len;
1281 /* print device info to dmesg */
1282 printk(KERN_INFO "ata%u: dev %u ATAPI, max %s\n",
1283 ap->id, device,
1284 ata_mode_string(xfer_modes));
1287 DPRINTK("EXIT, drv_stat = 0x%x\n", ata_chk_status(ap));
1288 return;
1290 err_out_nosup:
1291 printk(KERN_WARNING "ata%u: dev %u not supported, ignoring\n",
1292 ap->id, device);
1293 err_out:
1294 dev->class++; /* converts ATA_DEV_xxx into ATA_DEV_xxx_UNSUP */
1295 DPRINTK("EXIT, err\n");
1299 static inline u8 ata_dev_knobble(struct ata_port *ap)
1301 return ((ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(ap->device->id)));
1305 * ata_dev_config - Run device specific handlers and check for
1306 * SATA->PATA bridges
1307 * @ap: Bus
1308 * @i: Device
1310 * LOCKING:
1313 void ata_dev_config(struct ata_port *ap, unsigned int i)
1315 /* limit bridge transfers to udma5, 200 sectors */
1316 if (ata_dev_knobble(ap)) {
1317 printk(KERN_INFO "ata%u(%u): applying bridge limits\n",
1318 ap->id, ap->device->devno);
1319 ap->udma_mask &= ATA_UDMA5;
1320 ap->host->max_sectors = ATA_MAX_SECTORS;
1321 ap->host->hostt->max_sectors = ATA_MAX_SECTORS;
1322 ap->device->flags |= ATA_DFLAG_LOCK_SECTORS;
1325 if (ap->ops->dev_config)
1326 ap->ops->dev_config(ap, &ap->device[i]);
1330 * ata_bus_probe - Reset and probe ATA bus
1331 * @ap: Bus to probe
1333 * Master ATA bus probing function. Initiates a hardware-dependent
1334 * bus reset, then attempts to identify any devices found on
1335 * the bus.
1337 * LOCKING:
1338 * PCI/etc. bus probe sem.
1340 * RETURNS:
1341 * Zero on success, non-zero on error.
1344 static int ata_bus_probe(struct ata_port *ap)
1346 unsigned int i, found = 0;
1348 ap->ops->phy_reset(ap);
1349 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1350 goto err_out;
1352 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1353 ata_dev_identify(ap, i);
1354 if (ata_dev_present(&ap->device[i])) {
1355 found = 1;
1356 ata_dev_config(ap,i);
1360 if ((!found) || (ap->flags & ATA_FLAG_PORT_DISABLED))
1361 goto err_out_disable;
1363 ata_set_mode(ap);
1364 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1365 goto err_out_disable;
1367 return 0;
1369 err_out_disable:
1370 ap->ops->port_disable(ap);
1371 err_out:
1372 return -1;
1376 * ata_port_probe - Mark port as enabled
1377 * @ap: Port for which we indicate enablement
1379 * Modify @ap data structure such that the system
1380 * thinks that the entire port is enabled.
1382 * LOCKING: host_set lock, or some other form of
1383 * serialization.
1386 void ata_port_probe(struct ata_port *ap)
1388 ap->flags &= ~ATA_FLAG_PORT_DISABLED;
1392 * __sata_phy_reset - Wake/reset a low-level SATA PHY
1393 * @ap: SATA port associated with target SATA PHY.
1395 * This function issues commands to standard SATA Sxxx
1396 * PHY registers, to wake up the phy (and device), and
1397 * clear any reset condition.
1399 * LOCKING:
1400 * PCI/etc. bus probe sem.
1403 void __sata_phy_reset(struct ata_port *ap)
1405 u32 sstatus;
1406 unsigned long timeout = jiffies + (HZ * 5);
1408 if (ap->flags & ATA_FLAG_SATA_RESET) {
1409 /* issue phy wake/reset */
1410 scr_write_flush(ap, SCR_CONTROL, 0x301);
1411 udelay(400); /* FIXME: a guess */
1413 scr_write_flush(ap, SCR_CONTROL, 0x300); /* phy wake/clear reset */
1415 /* wait for phy to become ready, if necessary */
1416 do {
1417 msleep(200);
1418 sstatus = scr_read(ap, SCR_STATUS);
1419 if ((sstatus & 0xf) != 1)
1420 break;
1421 } while (time_before(jiffies, timeout));
1423 /* TODO: phy layer with polling, timeouts, etc. */
1424 if (sata_dev_present(ap))
1425 ata_port_probe(ap);
1426 else {
1427 sstatus = scr_read(ap, SCR_STATUS);
1428 printk(KERN_INFO "ata%u: no device found (phy stat %08x)\n",
1429 ap->id, sstatus);
1430 ata_port_disable(ap);
1433 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1434 return;
1436 if (ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT)) {
1437 ata_port_disable(ap);
1438 return;
1441 ap->cbl = ATA_CBL_SATA;
1445 * sata_phy_reset - Reset SATA bus.
1446 * @ap: SATA port associated with target SATA PHY.
1448 * This function resets the SATA bus, and then probes
1449 * the bus for devices.
1451 * LOCKING:
1452 * PCI/etc. bus probe sem.
1455 void sata_phy_reset(struct ata_port *ap)
1457 __sata_phy_reset(ap);
1458 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1459 return;
1460 ata_bus_reset(ap);
1464 * ata_port_disable - Disable port.
1465 * @ap: Port to be disabled.
1467 * Modify @ap data structure such that the system
1468 * thinks that the entire port is disabled, and should
1469 * never attempt to probe or communicate with devices
1470 * on this port.
1472 * LOCKING: host_set lock, or some other form of
1473 * serialization.
1476 void ata_port_disable(struct ata_port *ap)
1478 ap->device[0].class = ATA_DEV_NONE;
1479 ap->device[1].class = ATA_DEV_NONE;
1480 ap->flags |= ATA_FLAG_PORT_DISABLED;
1483 static struct {
1484 unsigned int shift;
1485 u8 base;
1486 } xfer_mode_classes[] = {
1487 { ATA_SHIFT_UDMA, XFER_UDMA_0 },
1488 { ATA_SHIFT_MWDMA, XFER_MW_DMA_0 },
1489 { ATA_SHIFT_PIO, XFER_PIO_0 },
1492 static inline u8 base_from_shift(unsigned int shift)
1494 int i;
1496 for (i = 0; i < ARRAY_SIZE(xfer_mode_classes); i++)
1497 if (xfer_mode_classes[i].shift == shift)
1498 return xfer_mode_classes[i].base;
1500 return 0xff;
1503 static void ata_dev_set_mode(struct ata_port *ap, struct ata_device *dev)
1505 int ofs, idx;
1506 u8 base;
1508 if (!ata_dev_present(dev) || (ap->flags & ATA_FLAG_PORT_DISABLED))
1509 return;
1511 if (dev->xfer_shift == ATA_SHIFT_PIO)
1512 dev->flags |= ATA_DFLAG_PIO;
1514 ata_dev_set_xfermode(ap, dev);
1516 base = base_from_shift(dev->xfer_shift);
1517 ofs = dev->xfer_mode - base;
1518 idx = ofs + dev->xfer_shift;
1519 WARN_ON(idx >= ARRAY_SIZE(xfer_mode_str));
1521 DPRINTK("idx=%d xfer_shift=%u, xfer_mode=0x%x, base=0x%x, offset=%d\n",
1522 idx, dev->xfer_shift, (int)dev->xfer_mode, (int)base, ofs);
1524 printk(KERN_INFO "ata%u: dev %u configured for %s\n",
1525 ap->id, dev->devno, xfer_mode_str[idx]);
1528 static int ata_host_set_pio(struct ata_port *ap)
1530 unsigned int mask;
1531 int x, i;
1532 u8 base, xfer_mode;
1534 mask = ata_get_mode_mask(ap, ATA_SHIFT_PIO);
1535 x = fgb(mask);
1536 if (x < 0) {
1537 printk(KERN_WARNING "ata%u: no PIO support\n", ap->id);
1538 return -1;
1541 base = base_from_shift(ATA_SHIFT_PIO);
1542 xfer_mode = base + x;
1544 DPRINTK("base 0x%x xfer_mode 0x%x mask 0x%x x %d\n",
1545 (int)base, (int)xfer_mode, mask, x);
1547 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1548 struct ata_device *dev = &ap->device[i];
1549 if (ata_dev_present(dev)) {
1550 dev->pio_mode = xfer_mode;
1551 dev->xfer_mode = xfer_mode;
1552 dev->xfer_shift = ATA_SHIFT_PIO;
1553 if (ap->ops->set_piomode)
1554 ap->ops->set_piomode(ap, dev);
1558 return 0;
1561 static void ata_host_set_dma(struct ata_port *ap, u8 xfer_mode,
1562 unsigned int xfer_shift)
1564 int i;
1566 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1567 struct ata_device *dev = &ap->device[i];
1568 if (ata_dev_present(dev)) {
1569 dev->dma_mode = xfer_mode;
1570 dev->xfer_mode = xfer_mode;
1571 dev->xfer_shift = xfer_shift;
1572 if (ap->ops->set_dmamode)
1573 ap->ops->set_dmamode(ap, dev);
1579 * ata_set_mode - Program timings and issue SET FEATURES - XFER
1580 * @ap: port on which timings will be programmed
1582 * Set ATA device disk transfer mode (PIO3, UDMA6, etc.).
1584 * LOCKING:
1585 * PCI/etc. bus probe sem.
1588 static void ata_set_mode(struct ata_port *ap)
1590 unsigned int i, xfer_shift;
1591 u8 xfer_mode;
1592 int rc;
1594 /* step 1: always set host PIO timings */
1595 rc = ata_host_set_pio(ap);
1596 if (rc)
1597 goto err_out;
1599 /* step 2: choose the best data xfer mode */
1600 xfer_mode = xfer_shift = 0;
1601 rc = ata_choose_xfer_mode(ap, &xfer_mode, &xfer_shift);
1602 if (rc)
1603 goto err_out;
1605 /* step 3: if that xfer mode isn't PIO, set host DMA timings */
1606 if (xfer_shift != ATA_SHIFT_PIO)
1607 ata_host_set_dma(ap, xfer_mode, xfer_shift);
1609 /* step 4: update devices' xfer mode */
1610 ata_dev_set_mode(ap, &ap->device[0]);
1611 ata_dev_set_mode(ap, &ap->device[1]);
1613 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1614 return;
1616 if (ap->ops->post_set_mode)
1617 ap->ops->post_set_mode(ap);
1619 for (i = 0; i < 2; i++) {
1620 struct ata_device *dev = &ap->device[i];
1621 ata_dev_set_protocol(dev);
1624 return;
1626 err_out:
1627 ata_port_disable(ap);
1631 * ata_busy_sleep - sleep until BSY clears, or timeout
1632 * @ap: port containing status register to be polled
1633 * @tmout_pat: impatience timeout
1634 * @tmout: overall timeout
1636 * Sleep until ATA Status register bit BSY clears,
1637 * or a timeout occurs.
1639 * LOCKING: None.
1643 static unsigned int ata_busy_sleep (struct ata_port *ap,
1644 unsigned long tmout_pat,
1645 unsigned long tmout)
1647 unsigned long timer_start, timeout;
1648 u8 status;
1650 status = ata_busy_wait(ap, ATA_BUSY, 300);
1651 timer_start = jiffies;
1652 timeout = timer_start + tmout_pat;
1653 while ((status & ATA_BUSY) && (time_before(jiffies, timeout))) {
1654 msleep(50);
1655 status = ata_busy_wait(ap, ATA_BUSY, 3);
1658 if (status & ATA_BUSY)
1659 printk(KERN_WARNING "ata%u is slow to respond, "
1660 "please be patient\n", ap->id);
1662 timeout = timer_start + tmout;
1663 while ((status & ATA_BUSY) && (time_before(jiffies, timeout))) {
1664 msleep(50);
1665 status = ata_chk_status(ap);
1668 if (status & ATA_BUSY) {
1669 printk(KERN_ERR "ata%u failed to respond (%lu secs)\n",
1670 ap->id, tmout / HZ);
1671 return 1;
1674 return 0;
1677 static void ata_bus_post_reset(struct ata_port *ap, unsigned int devmask)
1679 struct ata_ioports *ioaddr = &ap->ioaddr;
1680 unsigned int dev0 = devmask & (1 << 0);
1681 unsigned int dev1 = devmask & (1 << 1);
1682 unsigned long timeout;
1684 /* if device 0 was found in ata_devchk, wait for its
1685 * BSY bit to clear
1687 if (dev0)
1688 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1690 /* if device 1 was found in ata_devchk, wait for
1691 * register access, then wait for BSY to clear
1693 timeout = jiffies + ATA_TMOUT_BOOT;
1694 while (dev1) {
1695 u8 nsect, lbal;
1697 ap->ops->dev_select(ap, 1);
1698 if (ap->flags & ATA_FLAG_MMIO) {
1699 nsect = readb((void __iomem *) ioaddr->nsect_addr);
1700 lbal = readb((void __iomem *) ioaddr->lbal_addr);
1701 } else {
1702 nsect = inb(ioaddr->nsect_addr);
1703 lbal = inb(ioaddr->lbal_addr);
1705 if ((nsect == 1) && (lbal == 1))
1706 break;
1707 if (time_after(jiffies, timeout)) {
1708 dev1 = 0;
1709 break;
1711 msleep(50); /* give drive a breather */
1713 if (dev1)
1714 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1716 /* is all this really necessary? */
1717 ap->ops->dev_select(ap, 0);
1718 if (dev1)
1719 ap->ops->dev_select(ap, 1);
1720 if (dev0)
1721 ap->ops->dev_select(ap, 0);
1725 * ata_bus_edd - Issue EXECUTE DEVICE DIAGNOSTIC command.
1726 * @ap: Port to reset and probe
1728 * Use the EXECUTE DEVICE DIAGNOSTIC command to reset and
1729 * probe the bus. Not often used these days.
1731 * LOCKING:
1732 * PCI/etc. bus probe sem.
1736 static unsigned int ata_bus_edd(struct ata_port *ap)
1738 struct ata_taskfile tf;
1740 /* set up execute-device-diag (bus reset) taskfile */
1741 /* also, take interrupts to a known state (disabled) */
1742 DPRINTK("execute-device-diag\n");
1743 ata_tf_init(ap, &tf, 0);
1744 tf.ctl |= ATA_NIEN;
1745 tf.command = ATA_CMD_EDD;
1746 tf.protocol = ATA_PROT_NODATA;
1748 /* do bus reset */
1749 ata_tf_to_host(ap, &tf);
1751 /* spec says at least 2ms. but who knows with those
1752 * crazy ATAPI devices...
1754 msleep(150);
1756 return ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1759 static unsigned int ata_bus_softreset(struct ata_port *ap,
1760 unsigned int devmask)
1762 struct ata_ioports *ioaddr = &ap->ioaddr;
1764 DPRINTK("ata%u: bus reset via SRST\n", ap->id);
1766 /* software reset. causes dev0 to be selected */
1767 if (ap->flags & ATA_FLAG_MMIO) {
1768 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1769 udelay(20); /* FIXME: flush */
1770 writeb(ap->ctl | ATA_SRST, (void __iomem *) ioaddr->ctl_addr);
1771 udelay(20); /* FIXME: flush */
1772 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1773 } else {
1774 outb(ap->ctl, ioaddr->ctl_addr);
1775 udelay(10);
1776 outb(ap->ctl | ATA_SRST, ioaddr->ctl_addr);
1777 udelay(10);
1778 outb(ap->ctl, ioaddr->ctl_addr);
1781 /* spec mandates ">= 2ms" before checking status.
1782 * We wait 150ms, because that was the magic delay used for
1783 * ATAPI devices in Hale Landis's ATADRVR, for the period of time
1784 * between when the ATA command register is written, and then
1785 * status is checked. Because waiting for "a while" before
1786 * checking status is fine, post SRST, we perform this magic
1787 * delay here as well.
1789 msleep(150);
1791 ata_bus_post_reset(ap, devmask);
1793 return 0;
1797 * ata_bus_reset - reset host port and associated ATA channel
1798 * @ap: port to reset
1800 * This is typically the first time we actually start issuing
1801 * commands to the ATA channel. We wait for BSY to clear, then
1802 * issue EXECUTE DEVICE DIAGNOSTIC command, polling for its
1803 * result. Determine what devices, if any, are on the channel
1804 * by looking at the device 0/1 error register. Look at the signature
1805 * stored in each device's taskfile registers, to determine if
1806 * the device is ATA or ATAPI.
1808 * LOCKING:
1809 * PCI/etc. bus probe sem.
1810 * Obtains host_set lock.
1812 * SIDE EFFECTS:
1813 * Sets ATA_FLAG_PORT_DISABLED if bus reset fails.
1816 void ata_bus_reset(struct ata_port *ap)
1818 struct ata_ioports *ioaddr = &ap->ioaddr;
1819 unsigned int slave_possible = ap->flags & ATA_FLAG_SLAVE_POSS;
1820 u8 err;
1821 unsigned int dev0, dev1 = 0, rc = 0, devmask = 0;
1823 DPRINTK("ENTER, host %u, port %u\n", ap->id, ap->port_no);
1825 /* determine if device 0/1 are present */
1826 if (ap->flags & ATA_FLAG_SATA_RESET)
1827 dev0 = 1;
1828 else {
1829 dev0 = ata_devchk(ap, 0);
1830 if (slave_possible)
1831 dev1 = ata_devchk(ap, 1);
1834 if (dev0)
1835 devmask |= (1 << 0);
1836 if (dev1)
1837 devmask |= (1 << 1);
1839 /* select device 0 again */
1840 ap->ops->dev_select(ap, 0);
1842 /* issue bus reset */
1843 if (ap->flags & ATA_FLAG_SRST)
1844 rc = ata_bus_softreset(ap, devmask);
1845 else if ((ap->flags & ATA_FLAG_SATA_RESET) == 0) {
1846 /* set up device control */
1847 if (ap->flags & ATA_FLAG_MMIO)
1848 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1849 else
1850 outb(ap->ctl, ioaddr->ctl_addr);
1851 rc = ata_bus_edd(ap);
1854 if (rc)
1855 goto err_out;
1858 * determine by signature whether we have ATA or ATAPI devices
1860 err = ata_dev_try_classify(ap, 0);
1861 if ((slave_possible) && (err != 0x81))
1862 ata_dev_try_classify(ap, 1);
1864 /* re-enable interrupts */
1865 if (ap->ioaddr.ctl_addr) /* FIXME: hack. create a hook instead */
1866 ata_irq_on(ap);
1868 /* is double-select really necessary? */
1869 if (ap->device[1].class != ATA_DEV_NONE)
1870 ap->ops->dev_select(ap, 1);
1871 if (ap->device[0].class != ATA_DEV_NONE)
1872 ap->ops->dev_select(ap, 0);
1874 /* if no devices were detected, disable this port */
1875 if ((ap->device[0].class == ATA_DEV_NONE) &&
1876 (ap->device[1].class == ATA_DEV_NONE))
1877 goto err_out;
1879 if (ap->flags & (ATA_FLAG_SATA_RESET | ATA_FLAG_SRST)) {
1880 /* set up device control for ATA_FLAG_SATA_RESET */
1881 if (ap->flags & ATA_FLAG_MMIO)
1882 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1883 else
1884 outb(ap->ctl, ioaddr->ctl_addr);
1887 DPRINTK("EXIT\n");
1888 return;
1890 err_out:
1891 printk(KERN_ERR "ata%u: disabling port\n", ap->id);
1892 ap->ops->port_disable(ap);
1894 DPRINTK("EXIT\n");
1897 static void ata_pr_blacklisted(struct ata_port *ap, struct ata_device *dev)
1899 printk(KERN_WARNING "ata%u: dev %u is on DMA blacklist, disabling DMA\n",
1900 ap->id, dev->devno);
1903 static const char * ata_dma_blacklist [] = {
1904 "WDC AC11000H",
1905 "WDC AC22100H",
1906 "WDC AC32500H",
1907 "WDC AC33100H",
1908 "WDC AC31600H",
1909 "WDC AC32100H",
1910 "WDC AC23200L",
1911 "Compaq CRD-8241B",
1912 "CRD-8400B",
1913 "CRD-8480B",
1914 "CRD-8482B",
1915 "CRD-84",
1916 "SanDisk SDP3B",
1917 "SanDisk SDP3B-64",
1918 "SANYO CD-ROM CRD",
1919 "HITACHI CDR-8",
1920 "HITACHI CDR-8335",
1921 "HITACHI CDR-8435",
1922 "Toshiba CD-ROM XM-6202B",
1923 "TOSHIBA CD-ROM XM-1702BC",
1924 "CD-532E-A",
1925 "E-IDE CD-ROM CR-840",
1926 "CD-ROM Drive/F5A",
1927 "WPI CDD-820",
1928 "SAMSUNG CD-ROM SC-148C",
1929 "SAMSUNG CD-ROM SC",
1930 "SanDisk SDP3B-64",
1931 "ATAPI CD-ROM DRIVE 40X MAXIMUM",
1932 "_NEC DV5800A",
1935 static int ata_dma_blacklisted(struct ata_port *ap, struct ata_device *dev)
1937 unsigned char model_num[40];
1938 char *s;
1939 unsigned int len;
1940 int i;
1942 ata_dev_id_string(dev->id, model_num, ATA_ID_PROD_OFS,
1943 sizeof(model_num));
1944 s = &model_num[0];
1945 len = strnlen(s, sizeof(model_num));
1947 /* ATAPI specifies that empty space is blank-filled; remove blanks */
1948 while ((len > 0) && (s[len - 1] == ' ')) {
1949 len--;
1950 s[len] = 0;
1953 for (i = 0; i < ARRAY_SIZE(ata_dma_blacklist); i++)
1954 if (!strncmp(ata_dma_blacklist[i], s, len))
1955 return 1;
1957 return 0;
1960 static unsigned int ata_get_mode_mask(struct ata_port *ap, int shift)
1962 struct ata_device *master, *slave;
1963 unsigned int mask;
1965 master = &ap->device[0];
1966 slave = &ap->device[1];
1968 assert (ata_dev_present(master) || ata_dev_present(slave));
1970 if (shift == ATA_SHIFT_UDMA) {
1971 mask = ap->udma_mask;
1972 if (ata_dev_present(master)) {
1973 mask &= (master->id[ATA_ID_UDMA_MODES] & 0xff);
1974 if (ata_dma_blacklisted(ap, master)) {
1975 mask = 0;
1976 ata_pr_blacklisted(ap, master);
1979 if (ata_dev_present(slave)) {
1980 mask &= (slave->id[ATA_ID_UDMA_MODES] & 0xff);
1981 if (ata_dma_blacklisted(ap, slave)) {
1982 mask = 0;
1983 ata_pr_blacklisted(ap, slave);
1987 else if (shift == ATA_SHIFT_MWDMA) {
1988 mask = ap->mwdma_mask;
1989 if (ata_dev_present(master)) {
1990 mask &= (master->id[ATA_ID_MWDMA_MODES] & 0x07);
1991 if (ata_dma_blacklisted(ap, master)) {
1992 mask = 0;
1993 ata_pr_blacklisted(ap, master);
1996 if (ata_dev_present(slave)) {
1997 mask &= (slave->id[ATA_ID_MWDMA_MODES] & 0x07);
1998 if (ata_dma_blacklisted(ap, slave)) {
1999 mask = 0;
2000 ata_pr_blacklisted(ap, slave);
2004 else if (shift == ATA_SHIFT_PIO) {
2005 mask = ap->pio_mask;
2006 if (ata_dev_present(master)) {
2007 /* spec doesn't return explicit support for
2008 * PIO0-2, so we fake it
2010 u16 tmp_mode = master->id[ATA_ID_PIO_MODES] & 0x03;
2011 tmp_mode <<= 3;
2012 tmp_mode |= 0x7;
2013 mask &= tmp_mode;
2015 if (ata_dev_present(slave)) {
2016 /* spec doesn't return explicit support for
2017 * PIO0-2, so we fake it
2019 u16 tmp_mode = slave->id[ATA_ID_PIO_MODES] & 0x03;
2020 tmp_mode <<= 3;
2021 tmp_mode |= 0x7;
2022 mask &= tmp_mode;
2025 else {
2026 mask = 0xffffffff; /* shut up compiler warning */
2027 BUG();
2030 return mask;
2033 /* find greatest bit */
2034 static int fgb(u32 bitmap)
2036 unsigned int i;
2037 int x = -1;
2039 for (i = 0; i < 32; i++)
2040 if (bitmap & (1 << i))
2041 x = i;
2043 return x;
2047 * ata_choose_xfer_mode - attempt to find best transfer mode
2048 * @ap: Port for which an xfer mode will be selected
2049 * @xfer_mode_out: (output) SET FEATURES - XFER MODE code
2050 * @xfer_shift_out: (output) bit shift that selects this mode
2052 * Based on host and device capabilities, determine the
2053 * maximum transfer mode that is amenable to all.
2055 * LOCKING:
2056 * PCI/etc. bus probe sem.
2058 * RETURNS:
2059 * Zero on success, negative on error.
2062 static int ata_choose_xfer_mode(struct ata_port *ap,
2063 u8 *xfer_mode_out,
2064 unsigned int *xfer_shift_out)
2066 unsigned int mask, shift;
2067 int x, i;
2069 for (i = 0; i < ARRAY_SIZE(xfer_mode_classes); i++) {
2070 shift = xfer_mode_classes[i].shift;
2071 mask = ata_get_mode_mask(ap, shift);
2073 x = fgb(mask);
2074 if (x >= 0) {
2075 *xfer_mode_out = xfer_mode_classes[i].base + x;
2076 *xfer_shift_out = shift;
2077 return 0;
2081 return -1;
2085 * ata_dev_set_xfermode - Issue SET FEATURES - XFER MODE command
2086 * @ap: Port associated with device @dev
2087 * @dev: Device to which command will be sent
2089 * Issue SET FEATURES - XFER MODE command to device @dev
2090 * on port @ap.
2092 * LOCKING:
2093 * PCI/etc. bus probe sem.
2096 static void ata_dev_set_xfermode(struct ata_port *ap, struct ata_device *dev)
2098 DECLARE_COMPLETION(wait);
2099 struct ata_queued_cmd *qc;
2100 int rc;
2101 unsigned long flags;
2103 /* set up set-features taskfile */
2104 DPRINTK("set features - xfer mode\n");
2106 qc = ata_qc_new_init(ap, dev);
2107 BUG_ON(qc == NULL);
2109 qc->tf.command = ATA_CMD_SET_FEATURES;
2110 qc->tf.feature = SETFEATURES_XFER;
2111 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2112 qc->tf.protocol = ATA_PROT_NODATA;
2113 qc->tf.nsect = dev->xfer_mode;
2115 qc->waiting = &wait;
2116 qc->complete_fn = ata_qc_complete_noop;
2118 spin_lock_irqsave(&ap->host_set->lock, flags);
2119 rc = ata_qc_issue(qc);
2120 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2122 if (rc)
2123 ata_port_disable(ap);
2124 else
2125 wait_for_completion(&wait);
2127 DPRINTK("EXIT\n");
2131 * ata_sg_clean - Unmap DMA memory associated with command
2132 * @qc: Command containing DMA memory to be released
2134 * Unmap all mapped DMA memory associated with this command.
2136 * LOCKING:
2137 * spin_lock_irqsave(host_set lock)
2140 static void ata_sg_clean(struct ata_queued_cmd *qc)
2142 struct ata_port *ap = qc->ap;
2143 struct scatterlist *sg = qc->sg;
2144 int dir = qc->dma_dir;
2146 assert(qc->flags & ATA_QCFLAG_DMAMAP);
2147 assert(sg != NULL);
2149 if (qc->flags & ATA_QCFLAG_SINGLE)
2150 assert(qc->n_elem == 1);
2152 DPRINTK("unmapping %u sg elements\n", qc->n_elem);
2154 if (qc->flags & ATA_QCFLAG_SG)
2155 dma_unmap_sg(ap->host_set->dev, sg, qc->n_elem, dir);
2156 else
2157 dma_unmap_single(ap->host_set->dev, sg_dma_address(&sg[0]),
2158 sg_dma_len(&sg[0]), dir);
2160 qc->flags &= ~ATA_QCFLAG_DMAMAP;
2161 qc->sg = NULL;
2165 * ata_fill_sg - Fill PCI IDE PRD table
2166 * @qc: Metadata associated with taskfile to be transferred
2168 * Fill PCI IDE PRD (scatter-gather) table with segments
2169 * associated with the current disk command.
2171 * LOCKING:
2172 * spin_lock_irqsave(host_set lock)
2175 static void ata_fill_sg(struct ata_queued_cmd *qc)
2177 struct scatterlist *sg = qc->sg;
2178 struct ata_port *ap = qc->ap;
2179 unsigned int idx, nelem;
2181 assert(sg != NULL);
2182 assert(qc->n_elem > 0);
2184 idx = 0;
2185 for (nelem = qc->n_elem; nelem; nelem--,sg++) {
2186 u32 addr, offset;
2187 u32 sg_len, len;
2189 /* determine if physical DMA addr spans 64K boundary.
2190 * Note h/w doesn't support 64-bit, so we unconditionally
2191 * truncate dma_addr_t to u32.
2193 addr = (u32) sg_dma_address(sg);
2194 sg_len = sg_dma_len(sg);
2196 while (sg_len) {
2197 offset = addr & 0xffff;
2198 len = sg_len;
2199 if ((offset + sg_len) > 0x10000)
2200 len = 0x10000 - offset;
2202 ap->prd[idx].addr = cpu_to_le32(addr);
2203 ap->prd[idx].flags_len = cpu_to_le32(len & 0xffff);
2204 VPRINTK("PRD[%u] = (0x%X, 0x%X)\n", idx, addr, len);
2206 idx++;
2207 sg_len -= len;
2208 addr += len;
2212 if (idx)
2213 ap->prd[idx - 1].flags_len |= cpu_to_le32(ATA_PRD_EOT);
2216 * ata_check_atapi_dma - Check whether ATAPI DMA can be supported
2217 * @qc: Metadata associated with taskfile to check
2219 * Allow low-level driver to filter ATA PACKET commands, returning
2220 * a status indicating whether or not it is OK to use DMA for the
2221 * supplied PACKET command.
2223 * LOCKING:
2224 * spin_lock_irqsave(host_set lock)
2226 * RETURNS: 0 when ATAPI DMA can be used
2227 * nonzero otherwise
2229 int ata_check_atapi_dma(struct ata_queued_cmd *qc)
2231 struct ata_port *ap = qc->ap;
2232 int rc = 0; /* Assume ATAPI DMA is OK by default */
2234 if (ap->ops->check_atapi_dma)
2235 rc = ap->ops->check_atapi_dma(qc);
2237 return rc;
2240 * ata_qc_prep - Prepare taskfile for submission
2241 * @qc: Metadata associated with taskfile to be prepared
2243 * Prepare ATA taskfile for submission.
2245 * LOCKING:
2246 * spin_lock_irqsave(host_set lock)
2248 void ata_qc_prep(struct ata_queued_cmd *qc)
2250 if (!(qc->flags & ATA_QCFLAG_DMAMAP))
2251 return;
2253 ata_fill_sg(qc);
2257 * ata_sg_init_one - Associate command with memory buffer
2258 * @qc: Command to be associated
2259 * @buf: Memory buffer
2260 * @buflen: Length of memory buffer, in bytes.
2262 * Initialize the data-related elements of queued_cmd @qc
2263 * to point to a single memory buffer, @buf of byte length @buflen.
2265 * LOCKING:
2266 * spin_lock_irqsave(host_set lock)
2272 * ata_sg_init_one - Prepare a one-entry scatter-gather list.
2273 * @qc: Queued command
2274 * @buf: transfer buffer
2275 * @buflen: length of buf
2277 * Builds a single-entry scatter-gather list to initiate a
2278 * transfer utilizing the specified buffer.
2280 * LOCKING:
2282 void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, unsigned int buflen)
2284 struct scatterlist *sg;
2286 qc->flags |= ATA_QCFLAG_SINGLE;
2288 memset(&qc->sgent, 0, sizeof(qc->sgent));
2289 qc->sg = &qc->sgent;
2290 qc->n_elem = 1;
2291 qc->buf_virt = buf;
2293 sg = qc->sg;
2294 sg->page = virt_to_page(buf);
2295 sg->offset = (unsigned long) buf & ~PAGE_MASK;
2296 sg->length = buflen;
2300 * ata_sg_init - Associate command with scatter-gather table.
2301 * @qc: Command to be associated
2302 * @sg: Scatter-gather table.
2303 * @n_elem: Number of elements in s/g table.
2305 * Initialize the data-related elements of queued_cmd @qc
2306 * to point to a scatter-gather table @sg, containing @n_elem
2307 * elements.
2309 * LOCKING:
2310 * spin_lock_irqsave(host_set lock)
2315 * ata_sg_init - Assign a scatter gather list to a queued command
2316 * @qc: Queued command
2317 * @sg: Scatter-gather list
2318 * @n_elem: length of sg list
2320 * Attaches a scatter-gather list to a queued command.
2322 * LOCKING:
2325 void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
2326 unsigned int n_elem)
2328 qc->flags |= ATA_QCFLAG_SG;
2329 qc->sg = sg;
2330 qc->n_elem = n_elem;
2334 * ata_sg_setup_one - DMA-map the memory buffer associated with a command.
2335 * @qc: Command with memory buffer to be mapped.
2337 * DMA-map the memory buffer associated with queued_cmd @qc.
2339 * LOCKING:
2340 * spin_lock_irqsave(host_set lock)
2342 * RETURNS:
2343 * Zero on success, negative on error.
2346 static int ata_sg_setup_one(struct ata_queued_cmd *qc)
2348 struct ata_port *ap = qc->ap;
2349 int dir = qc->dma_dir;
2350 struct scatterlist *sg = qc->sg;
2351 dma_addr_t dma_address;
2353 dma_address = dma_map_single(ap->host_set->dev, qc->buf_virt,
2354 sg->length, dir);
2355 if (dma_mapping_error(dma_address))
2356 return -1;
2358 sg_dma_address(sg) = dma_address;
2359 sg_dma_len(sg) = sg->length;
2361 DPRINTK("mapped buffer of %d bytes for %s\n", sg_dma_len(sg),
2362 qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
2364 return 0;
2368 * ata_sg_setup - DMA-map the scatter-gather table associated with a command.
2369 * @qc: Command with scatter-gather table to be mapped.
2371 * DMA-map the scatter-gather table associated with queued_cmd @qc.
2373 * LOCKING:
2374 * spin_lock_irqsave(host_set lock)
2376 * RETURNS:
2377 * Zero on success, negative on error.
2381 static int ata_sg_setup(struct ata_queued_cmd *qc)
2383 struct ata_port *ap = qc->ap;
2384 struct scatterlist *sg = qc->sg;
2385 int n_elem, dir;
2387 VPRINTK("ENTER, ata%u\n", ap->id);
2388 assert(qc->flags & ATA_QCFLAG_SG);
2390 dir = qc->dma_dir;
2391 n_elem = dma_map_sg(ap->host_set->dev, sg, qc->n_elem, dir);
2392 if (n_elem < 1)
2393 return -1;
2395 DPRINTK("%d sg elements mapped\n", n_elem);
2397 qc->n_elem = n_elem;
2399 return 0;
2403 * ata_pio_poll -
2404 * @ap:
2406 * LOCKING:
2407 * None. (executing in kernel thread context)
2409 * RETURNS:
2413 static unsigned long ata_pio_poll(struct ata_port *ap)
2415 u8 status;
2416 unsigned int poll_state = PIO_ST_UNKNOWN;
2417 unsigned int reg_state = PIO_ST_UNKNOWN;
2418 const unsigned int tmout_state = PIO_ST_TMOUT;
2420 switch (ap->pio_task_state) {
2421 case PIO_ST:
2422 case PIO_ST_POLL:
2423 poll_state = PIO_ST_POLL;
2424 reg_state = PIO_ST;
2425 break;
2426 case PIO_ST_LAST:
2427 case PIO_ST_LAST_POLL:
2428 poll_state = PIO_ST_LAST_POLL;
2429 reg_state = PIO_ST_LAST;
2430 break;
2431 default:
2432 BUG();
2433 break;
2436 status = ata_chk_status(ap);
2437 if (status & ATA_BUSY) {
2438 if (time_after(jiffies, ap->pio_task_timeout)) {
2439 ap->pio_task_state = tmout_state;
2440 return 0;
2442 ap->pio_task_state = poll_state;
2443 return ATA_SHORT_PAUSE;
2446 ap->pio_task_state = reg_state;
2447 return 0;
2451 * ata_pio_complete -
2452 * @ap:
2454 * LOCKING:
2455 * None. (executing in kernel thread context)
2458 static void ata_pio_complete (struct ata_port *ap)
2460 struct ata_queued_cmd *qc;
2461 u8 drv_stat;
2464 * This is purely hueristic. This is a fast path.
2465 * Sometimes when we enter, BSY will be cleared in
2466 * a chk-status or two. If not, the drive is probably seeking
2467 * or something. Snooze for a couple msecs, then
2468 * chk-status again. If still busy, fall back to
2469 * PIO_ST_POLL state.
2471 drv_stat = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 10);
2472 if (drv_stat & (ATA_BUSY | ATA_DRQ)) {
2473 msleep(2);
2474 drv_stat = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 10);
2475 if (drv_stat & (ATA_BUSY | ATA_DRQ)) {
2476 ap->pio_task_state = PIO_ST_LAST_POLL;
2477 ap->pio_task_timeout = jiffies + ATA_TMOUT_PIO;
2478 return;
2482 drv_stat = ata_wait_idle(ap);
2483 if (!ata_ok(drv_stat)) {
2484 ap->pio_task_state = PIO_ST_ERR;
2485 return;
2488 qc = ata_qc_from_tag(ap, ap->active_tag);
2489 assert(qc != NULL);
2491 ap->pio_task_state = PIO_ST_IDLE;
2493 ata_irq_on(ap);
2495 ata_qc_complete(qc, drv_stat);
2500 * swap_buf_le16 -
2501 * @buf: Buffer to swap
2502 * @buf_words: Number of 16-bit words in buffer.
2504 * Swap halves of 16-bit words if needed to convert from
2505 * little-endian byte order to native cpu byte order, or
2506 * vice-versa.
2508 * LOCKING:
2510 void swap_buf_le16(u16 *buf, unsigned int buf_words)
2512 #ifdef __BIG_ENDIAN
2513 unsigned int i;
2515 for (i = 0; i < buf_words; i++)
2516 buf[i] = le16_to_cpu(buf[i]);
2517 #endif /* __BIG_ENDIAN */
2520 static void ata_mmio_data_xfer(struct ata_port *ap, unsigned char *buf,
2521 unsigned int buflen, int write_data)
2523 unsigned int i;
2524 unsigned int words = buflen >> 1;
2525 u16 *buf16 = (u16 *) buf;
2526 void __iomem *mmio = (void __iomem *)ap->ioaddr.data_addr;
2528 if (write_data) {
2529 for (i = 0; i < words; i++)
2530 writew(le16_to_cpu(buf16[i]), mmio);
2531 } else {
2532 for (i = 0; i < words; i++)
2533 buf16[i] = cpu_to_le16(readw(mmio));
2537 static void ata_pio_data_xfer(struct ata_port *ap, unsigned char *buf,
2538 unsigned int buflen, int write_data)
2540 unsigned int dwords = buflen >> 1;
2542 if (write_data)
2543 outsw(ap->ioaddr.data_addr, buf, dwords);
2544 else
2545 insw(ap->ioaddr.data_addr, buf, dwords);
2548 static void ata_data_xfer(struct ata_port *ap, unsigned char *buf,
2549 unsigned int buflen, int do_write)
2551 if (ap->flags & ATA_FLAG_MMIO)
2552 ata_mmio_data_xfer(ap, buf, buflen, do_write);
2553 else
2554 ata_pio_data_xfer(ap, buf, buflen, do_write);
2557 static void ata_pio_sector(struct ata_queued_cmd *qc)
2559 int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
2560 struct scatterlist *sg = qc->sg;
2561 struct ata_port *ap = qc->ap;
2562 struct page *page;
2563 unsigned int offset;
2564 unsigned char *buf;
2566 if (qc->cursect == (qc->nsect - 1))
2567 ap->pio_task_state = PIO_ST_LAST;
2569 page = sg[qc->cursg].page;
2570 offset = sg[qc->cursg].offset + qc->cursg_ofs * ATA_SECT_SIZE;
2572 /* get the current page and offset */
2573 page = nth_page(page, (offset >> PAGE_SHIFT));
2574 offset %= PAGE_SIZE;
2576 buf = kmap(page) + offset;
2578 qc->cursect++;
2579 qc->cursg_ofs++;
2581 if ((qc->cursg_ofs * ATA_SECT_SIZE) == (&sg[qc->cursg])->length) {
2582 qc->cursg++;
2583 qc->cursg_ofs = 0;
2586 DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
2588 /* do the actual data transfer */
2589 do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
2590 ata_data_xfer(ap, buf, ATA_SECT_SIZE, do_write);
2592 kunmap(page);
2595 static void __atapi_pio_bytes(struct ata_queued_cmd *qc, unsigned int bytes)
2597 int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
2598 struct scatterlist *sg = qc->sg;
2599 struct ata_port *ap = qc->ap;
2600 struct page *page;
2601 unsigned char *buf;
2602 unsigned int offset, count;
2604 if (qc->curbytes == qc->nbytes - bytes)
2605 ap->pio_task_state = PIO_ST_LAST;
2607 next_sg:
2608 sg = &qc->sg[qc->cursg];
2610 page = sg->page;
2611 offset = sg->offset + qc->cursg_ofs;
2613 /* get the current page and offset */
2614 page = nth_page(page, (offset >> PAGE_SHIFT));
2615 offset %= PAGE_SIZE;
2617 /* don't overrun current sg */
2618 count = min(sg->length - qc->cursg_ofs, bytes);
2620 /* don't cross page boundaries */
2621 count = min(count, (unsigned int)PAGE_SIZE - offset);
2623 buf = kmap(page) + offset;
2625 bytes -= count;
2626 qc->curbytes += count;
2627 qc->cursg_ofs += count;
2629 if (qc->cursg_ofs == sg->length) {
2630 qc->cursg++;
2631 qc->cursg_ofs = 0;
2634 DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
2636 /* do the actual data transfer */
2637 ata_data_xfer(ap, buf, count, do_write);
2639 kunmap(page);
2641 if (bytes) {
2642 goto next_sg;
2646 static void atapi_pio_bytes(struct ata_queued_cmd *qc)
2648 struct ata_port *ap = qc->ap;
2649 struct ata_device *dev = qc->dev;
2650 unsigned int ireason, bc_lo, bc_hi, bytes;
2651 int i_write, do_write = (qc->tf.flags & ATA_TFLAG_WRITE) ? 1 : 0;
2653 ap->ops->tf_read(ap, &qc->tf);
2654 ireason = qc->tf.nsect;
2655 bc_lo = qc->tf.lbam;
2656 bc_hi = qc->tf.lbah;
2657 bytes = (bc_hi << 8) | bc_lo;
2659 /* shall be cleared to zero, indicating xfer of data */
2660 if (ireason & (1 << 0))
2661 goto err_out;
2663 /* make sure transfer direction matches expected */
2664 i_write = ((ireason & (1 << 1)) == 0) ? 1 : 0;
2665 if (do_write != i_write)
2666 goto err_out;
2668 __atapi_pio_bytes(qc, bytes);
2670 return;
2672 err_out:
2673 printk(KERN_INFO "ata%u: dev %u: ATAPI check failed\n",
2674 ap->id, dev->devno);
2675 ap->pio_task_state = PIO_ST_ERR;
2679 * ata_pio_sector -
2680 * @ap:
2682 * LOCKING:
2683 * None. (executing in kernel thread context)
2686 static void ata_pio_block(struct ata_port *ap)
2688 struct ata_queued_cmd *qc;
2689 u8 status;
2692 * This is purely hueristic. This is a fast path.
2693 * Sometimes when we enter, BSY will be cleared in
2694 * a chk-status or two. If not, the drive is probably seeking
2695 * or something. Snooze for a couple msecs, then
2696 * chk-status again. If still busy, fall back to
2697 * PIO_ST_POLL state.
2699 status = ata_busy_wait(ap, ATA_BUSY, 5);
2700 if (status & ATA_BUSY) {
2701 msleep(2);
2702 status = ata_busy_wait(ap, ATA_BUSY, 10);
2703 if (status & ATA_BUSY) {
2704 ap->pio_task_state = PIO_ST_POLL;
2705 ap->pio_task_timeout = jiffies + ATA_TMOUT_PIO;
2706 return;
2710 qc = ata_qc_from_tag(ap, ap->active_tag);
2711 assert(qc != NULL);
2713 if (is_atapi_taskfile(&qc->tf)) {
2714 /* no more data to transfer or unsupported ATAPI command */
2715 if ((status & ATA_DRQ) == 0) {
2716 ap->pio_task_state = PIO_ST_IDLE;
2718 ata_irq_on(ap);
2720 ata_qc_complete(qc, status);
2721 return;
2724 atapi_pio_bytes(qc);
2725 } else {
2726 /* handle BSY=0, DRQ=0 as error */
2727 if ((status & ATA_DRQ) == 0) {
2728 ap->pio_task_state = PIO_ST_ERR;
2729 return;
2732 ata_pio_sector(qc);
2736 static void ata_pio_error(struct ata_port *ap)
2738 struct ata_queued_cmd *qc;
2739 u8 drv_stat;
2741 qc = ata_qc_from_tag(ap, ap->active_tag);
2742 assert(qc != NULL);
2744 drv_stat = ata_chk_status(ap);
2745 printk(KERN_WARNING "ata%u: PIO error, drv_stat 0x%x\n",
2746 ap->id, drv_stat);
2748 ap->pio_task_state = PIO_ST_IDLE;
2750 ata_irq_on(ap);
2752 ata_qc_complete(qc, drv_stat | ATA_ERR);
2755 static void ata_pio_task(void *_data)
2757 struct ata_port *ap = _data;
2758 unsigned long timeout = 0;
2760 switch (ap->pio_task_state) {
2761 case PIO_ST_IDLE:
2762 return;
2764 case PIO_ST:
2765 ata_pio_block(ap);
2766 break;
2768 case PIO_ST_LAST:
2769 ata_pio_complete(ap);
2770 break;
2772 case PIO_ST_POLL:
2773 case PIO_ST_LAST_POLL:
2774 timeout = ata_pio_poll(ap);
2775 break;
2777 case PIO_ST_TMOUT:
2778 case PIO_ST_ERR:
2779 ata_pio_error(ap);
2780 return;
2783 if (timeout)
2784 queue_delayed_work(ata_wq, &ap->pio_task,
2785 timeout);
2786 else
2787 queue_work(ata_wq, &ap->pio_task);
2790 static void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
2791 struct scsi_cmnd *cmd)
2793 DECLARE_COMPLETION(wait);
2794 struct ata_queued_cmd *qc;
2795 unsigned long flags;
2796 int rc;
2798 DPRINTK("ATAPI request sense\n");
2800 qc = ata_qc_new_init(ap, dev);
2801 BUG_ON(qc == NULL);
2803 /* FIXME: is this needed? */
2804 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2806 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2807 qc->dma_dir = DMA_FROM_DEVICE;
2809 memset(&qc->cdb, 0, ap->cdb_len);
2810 qc->cdb[0] = REQUEST_SENSE;
2811 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2813 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2814 qc->tf.command = ATA_CMD_PACKET;
2816 qc->tf.protocol = ATA_PROT_ATAPI;
2817 qc->tf.lbam = (8 * 1024) & 0xff;
2818 qc->tf.lbah = (8 * 1024) >> 8;
2819 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2821 qc->waiting = &wait;
2822 qc->complete_fn = ata_qc_complete_noop;
2824 spin_lock_irqsave(&ap->host_set->lock, flags);
2825 rc = ata_qc_issue(qc);
2826 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2828 if (rc)
2829 ata_port_disable(ap);
2830 else
2831 wait_for_completion(&wait);
2833 DPRINTK("EXIT\n");
2837 * ata_qc_timeout - Handle timeout of queued command
2838 * @qc: Command that timed out
2840 * Some part of the kernel (currently, only the SCSI layer)
2841 * has noticed that the active command on port @ap has not
2842 * completed after a specified length of time. Handle this
2843 * condition by disabling DMA (if necessary) and completing
2844 * transactions, with error if necessary.
2846 * This also handles the case of the "lost interrupt", where
2847 * for some reason (possibly hardware bug, possibly driver bug)
2848 * an interrupt was not delivered to the driver, even though the
2849 * transaction completed successfully.
2851 * LOCKING:
2852 * Inherited from SCSI layer (none, can sleep)
2855 static void ata_qc_timeout(struct ata_queued_cmd *qc)
2857 struct ata_port *ap = qc->ap;
2858 struct ata_device *dev = qc->dev;
2859 u8 host_stat = 0, drv_stat;
2861 DPRINTK("ENTER\n");
2863 /* FIXME: doesn't this conflict with timeout handling? */
2864 if (qc->dev->class == ATA_DEV_ATAPI && qc->scsicmd) {
2865 struct scsi_cmnd *cmd = qc->scsicmd;
2867 if (!scsi_eh_eflags_chk(cmd, SCSI_EH_CANCEL_CMD)) {
2869 /* finish completing original command */
2870 __ata_qc_complete(qc);
2872 atapi_request_sense(ap, dev, cmd);
2874 cmd->result = (CHECK_CONDITION << 1) | (DID_OK << 16);
2875 scsi_finish_command(cmd);
2877 goto out;
2881 /* hack alert! We cannot use the supplied completion
2882 * function from inside the ->eh_strategy_handler() thread.
2883 * libata is the only user of ->eh_strategy_handler() in
2884 * any kernel, so the default scsi_done() assumes it is
2885 * not being called from the SCSI EH.
2887 qc->scsidone = scsi_finish_command;
2889 switch (qc->tf.protocol) {
2891 case ATA_PROT_DMA:
2892 case ATA_PROT_ATAPI_DMA:
2893 host_stat = ap->ops->bmdma_status(ap);
2895 /* before we do anything else, clear DMA-Start bit */
2896 ap->ops->bmdma_stop(ap);
2898 /* fall through */
2900 default:
2901 ata_altstatus(ap);
2902 drv_stat = ata_chk_status(ap);
2904 /* ack bmdma irq events */
2905 ap->ops->irq_clear(ap);
2907 printk(KERN_ERR "ata%u: command 0x%x timeout, stat 0x%x host_stat 0x%x\n",
2908 ap->id, qc->tf.command, drv_stat, host_stat);
2910 /* complete taskfile transaction */
2911 ata_qc_complete(qc, drv_stat);
2912 break;
2914 out:
2915 DPRINTK("EXIT\n");
2919 * ata_eng_timeout - Handle timeout of queued command
2920 * @ap: Port on which timed-out command is active
2922 * Some part of the kernel (currently, only the SCSI layer)
2923 * has noticed that the active command on port @ap has not
2924 * completed after a specified length of time. Handle this
2925 * condition by disabling DMA (if necessary) and completing
2926 * transactions, with error if necessary.
2928 * This also handles the case of the "lost interrupt", where
2929 * for some reason (possibly hardware bug, possibly driver bug)
2930 * an interrupt was not delivered to the driver, even though the
2931 * transaction completed successfully.
2933 * LOCKING:
2934 * Inherited from SCSI layer (none, can sleep)
2937 void ata_eng_timeout(struct ata_port *ap)
2939 struct ata_queued_cmd *qc;
2941 DPRINTK("ENTER\n");
2943 qc = ata_qc_from_tag(ap, ap->active_tag);
2944 if (!qc) {
2945 printk(KERN_ERR "ata%u: BUG: timeout without command\n",
2946 ap->id);
2947 goto out;
2950 ata_qc_timeout(qc);
2952 out:
2953 DPRINTK("EXIT\n");
2957 * ata_qc_new - Request an available ATA command, for queueing
2958 * @ap: Port associated with device @dev
2959 * @dev: Device from whom we request an available command structure
2961 * LOCKING:
2962 * None.
2965 static struct ata_queued_cmd *ata_qc_new(struct ata_port *ap)
2967 struct ata_queued_cmd *qc = NULL;
2968 unsigned int i;
2970 for (i = 0; i < ATA_MAX_QUEUE; i++)
2971 if (!test_and_set_bit(i, &ap->qactive)) {
2972 qc = ata_qc_from_tag(ap, i);
2973 break;
2976 if (qc)
2977 qc->tag = i;
2979 return qc;
2983 * ata_qc_new_init - Request an available ATA command, and initialize it
2984 * @ap: Port associated with device @dev
2985 * @dev: Device from whom we request an available command structure
2987 * LOCKING:
2988 * None.
2991 struct ata_queued_cmd *ata_qc_new_init(struct ata_port *ap,
2992 struct ata_device *dev)
2994 struct ata_queued_cmd *qc;
2996 qc = ata_qc_new(ap);
2997 if (qc) {
2998 qc->sg = NULL;
2999 qc->flags = 0;
3000 qc->scsicmd = NULL;
3001 qc->ap = ap;
3002 qc->dev = dev;
3003 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
3004 qc->nsect = 0;
3005 qc->nbytes = qc->curbytes = 0;
3007 ata_tf_init(ap, &qc->tf, dev->devno);
3009 if (dev->flags & ATA_DFLAG_LBA48)
3010 qc->tf.flags |= ATA_TFLAG_LBA48;
3013 return qc;
3016 static int ata_qc_complete_noop(struct ata_queued_cmd *qc, u8 drv_stat)
3018 return 0;
3021 static void __ata_qc_complete(struct ata_queued_cmd *qc)
3023 struct ata_port *ap = qc->ap;
3024 unsigned int tag, do_clear = 0;
3026 qc->flags = 0;
3027 tag = qc->tag;
3028 if (likely(ata_tag_valid(tag))) {
3029 if (tag == ap->active_tag)
3030 ap->active_tag = ATA_TAG_POISON;
3031 qc->tag = ATA_TAG_POISON;
3032 do_clear = 1;
3035 if (qc->waiting) {
3036 struct completion *waiting = qc->waiting;
3037 qc->waiting = NULL;
3038 complete(waiting);
3041 if (likely(do_clear))
3042 clear_bit(tag, &ap->qactive);
3046 * ata_qc_free - free unused ata_queued_cmd
3047 * @qc: Command to complete
3049 * Designed to free unused ata_queued_cmd object
3050 * in case something prevents using it.
3052 * LOCKING:
3053 * spin_lock_irqsave(host_set lock)
3056 void ata_qc_free(struct ata_queued_cmd *qc)
3058 assert(qc != NULL); /* ata_qc_from_tag _might_ return NULL */
3059 assert(qc->waiting == NULL); /* nothing should be waiting */
3061 __ata_qc_complete(qc);
3065 * ata_qc_complete - Complete an active ATA command
3066 * @qc: Command to complete
3067 * @drv_stat: ATA Status register contents
3069 * Indicate to the mid and upper layers that an ATA
3070 * command has completed, with either an ok or not-ok status.
3072 * LOCKING:
3073 * spin_lock_irqsave(host_set lock)
3077 void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
3079 int rc;
3081 assert(qc != NULL); /* ata_qc_from_tag _might_ return NULL */
3082 assert(qc->flags & ATA_QCFLAG_ACTIVE);
3084 if (likely(qc->flags & ATA_QCFLAG_DMAMAP))
3085 ata_sg_clean(qc);
3087 /* call completion callback */
3088 rc = qc->complete_fn(qc, drv_stat);
3089 qc->flags &= ~ATA_QCFLAG_ACTIVE;
3091 /* if callback indicates not to complete command (non-zero),
3092 * return immediately
3094 if (rc != 0)
3095 return;
3097 __ata_qc_complete(qc);
3099 VPRINTK("EXIT\n");
3102 static inline int ata_should_dma_map(struct ata_queued_cmd *qc)
3104 struct ata_port *ap = qc->ap;
3106 switch (qc->tf.protocol) {
3107 case ATA_PROT_DMA:
3108 case ATA_PROT_ATAPI_DMA:
3109 return 1;
3111 case ATA_PROT_ATAPI:
3112 case ATA_PROT_PIO:
3113 case ATA_PROT_PIO_MULT:
3114 if (ap->flags & ATA_FLAG_PIO_DMA)
3115 return 1;
3117 /* fall through */
3119 default:
3120 return 0;
3123 /* never reached */
3127 * ata_qc_issue - issue taskfile to device
3128 * @qc: command to issue to device
3130 * Prepare an ATA command to submission to device.
3131 * This includes mapping the data into a DMA-able
3132 * area, filling in the S/G table, and finally
3133 * writing the taskfile to hardware, starting the command.
3135 * LOCKING:
3136 * spin_lock_irqsave(host_set lock)
3138 * RETURNS:
3139 * Zero on success, negative on error.
3142 int ata_qc_issue(struct ata_queued_cmd *qc)
3144 struct ata_port *ap = qc->ap;
3146 if (ata_should_dma_map(qc)) {
3147 if (qc->flags & ATA_QCFLAG_SG) {
3148 if (ata_sg_setup(qc))
3149 goto err_out;
3150 } else if (qc->flags & ATA_QCFLAG_SINGLE) {
3151 if (ata_sg_setup_one(qc))
3152 goto err_out;
3154 } else {
3155 qc->flags &= ~ATA_QCFLAG_DMAMAP;
3158 ap->ops->qc_prep(qc);
3160 qc->ap->active_tag = qc->tag;
3161 qc->flags |= ATA_QCFLAG_ACTIVE;
3163 return ap->ops->qc_issue(qc);
3165 err_out:
3166 return -1;
3171 * ata_qc_issue_prot - issue taskfile to device in proto-dependent manner
3172 * @qc: command to issue to device
3174 * Using various libata functions and hooks, this function
3175 * starts an ATA command. ATA commands are grouped into
3176 * classes called "protocols", and issuing each type of protocol
3177 * is slightly different.
3179 * May be used as the qc_issue() entry in ata_port_operations.
3181 * LOCKING:
3182 * spin_lock_irqsave(host_set lock)
3184 * RETURNS:
3185 * Zero on success, negative on error.
3188 int ata_qc_issue_prot(struct ata_queued_cmd *qc)
3190 struct ata_port *ap = qc->ap;
3192 ata_dev_select(ap, qc->dev->devno, 1, 0);
3194 switch (qc->tf.protocol) {
3195 case ATA_PROT_NODATA:
3196 ata_tf_to_host_nolock(ap, &qc->tf);
3197 break;
3199 case ATA_PROT_DMA:
3200 ap->ops->tf_load(ap, &qc->tf); /* load tf registers */
3201 ap->ops->bmdma_setup(qc); /* set up bmdma */
3202 ap->ops->bmdma_start(qc); /* initiate bmdma */
3203 break;
3205 case ATA_PROT_PIO: /* load tf registers, initiate polling pio */
3206 ata_qc_set_polling(qc);
3207 ata_tf_to_host_nolock(ap, &qc->tf);
3208 ap->pio_task_state = PIO_ST;
3209 queue_work(ata_wq, &ap->pio_task);
3210 break;
3212 case ATA_PROT_ATAPI:
3213 ata_qc_set_polling(qc);
3214 ata_tf_to_host_nolock(ap, &qc->tf);
3215 queue_work(ata_wq, &ap->packet_task);
3216 break;
3218 case ATA_PROT_ATAPI_NODATA:
3219 ata_tf_to_host_nolock(ap, &qc->tf);
3220 queue_work(ata_wq, &ap->packet_task);
3221 break;
3223 case ATA_PROT_ATAPI_DMA:
3224 ap->ops->tf_load(ap, &qc->tf); /* load tf registers */
3225 ap->ops->bmdma_setup(qc); /* set up bmdma */
3226 queue_work(ata_wq, &ap->packet_task);
3227 break;
3229 default:
3230 WARN_ON(1);
3231 return -1;
3234 return 0;
3238 * ata_bmdma_setup_mmio - Set up PCI IDE BMDMA transaction
3239 * @qc: Info associated with this ATA transaction.
3241 * LOCKING:
3242 * spin_lock_irqsave(host_set lock)
3245 static void ata_bmdma_setup_mmio (struct ata_queued_cmd *qc)
3247 struct ata_port *ap = qc->ap;
3248 unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
3249 u8 dmactl;
3250 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
3252 /* load PRD table addr. */
3253 mb(); /* make sure PRD table writes are visible to controller */
3254 writel(ap->prd_dma, mmio + ATA_DMA_TABLE_OFS);
3256 /* specify data direction, triple-check start bit is clear */
3257 dmactl = readb(mmio + ATA_DMA_CMD);
3258 dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
3259 if (!rw)
3260 dmactl |= ATA_DMA_WR;
3261 writeb(dmactl, mmio + ATA_DMA_CMD);
3263 /* issue r/w command */
3264 ap->ops->exec_command(ap, &qc->tf);
3268 * ata_bmdma_start - Start a PCI IDE BMDMA transaction
3269 * @qc: Info associated with this ATA transaction.
3271 * LOCKING:
3272 * spin_lock_irqsave(host_set lock)
3275 static void ata_bmdma_start_mmio (struct ata_queued_cmd *qc)
3277 struct ata_port *ap = qc->ap;
3278 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
3279 u8 dmactl;
3281 /* start host DMA transaction */
3282 dmactl = readb(mmio + ATA_DMA_CMD);
3283 writeb(dmactl | ATA_DMA_START, mmio + ATA_DMA_CMD);
3285 /* Strictly, one may wish to issue a readb() here, to
3286 * flush the mmio write. However, control also passes
3287 * to the hardware at this point, and it will interrupt
3288 * us when we are to resume control. So, in effect,
3289 * we don't care when the mmio write flushes.
3290 * Further, a read of the DMA status register _immediately_
3291 * following the write may not be what certain flaky hardware
3292 * is expected, so I think it is best to not add a readb()
3293 * without first all the MMIO ATA cards/mobos.
3294 * Or maybe I'm just being paranoid.
3299 * ata_bmdma_setup_pio - Set up PCI IDE BMDMA transaction (PIO)
3300 * @qc: Info associated with this ATA transaction.
3302 * LOCKING:
3303 * spin_lock_irqsave(host_set lock)
3306 static void ata_bmdma_setup_pio (struct ata_queued_cmd *qc)
3308 struct ata_port *ap = qc->ap;
3309 unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
3310 u8 dmactl;
3312 /* load PRD table addr. */
3313 outl(ap->prd_dma, ap->ioaddr.bmdma_addr + ATA_DMA_TABLE_OFS);
3315 /* specify data direction, triple-check start bit is clear */
3316 dmactl = inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3317 dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
3318 if (!rw)
3319 dmactl |= ATA_DMA_WR;
3320 outb(dmactl, ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3322 /* issue r/w command */
3323 ap->ops->exec_command(ap, &qc->tf);
3327 * ata_bmdma_start_pio - Start a PCI IDE BMDMA transaction (PIO)
3328 * @qc: Info associated with this ATA transaction.
3330 * LOCKING:
3331 * spin_lock_irqsave(host_set lock)
3334 static void ata_bmdma_start_pio (struct ata_queued_cmd *qc)
3336 struct ata_port *ap = qc->ap;
3337 u8 dmactl;
3339 /* start host DMA transaction */
3340 dmactl = inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3341 outb(dmactl | ATA_DMA_START,
3342 ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3347 * ata_bmdma_start - Start a PCI IDE BMDMA transaction
3348 * @qc: Info associated with this ATA transaction.
3350 * Writes the ATA_DMA_START flag to the DMA command register.
3352 * May be used as the bmdma_start() entry in ata_port_operations.
3354 * LOCKING:
3355 * spin_lock_irqsave(host_set lock)
3357 void ata_bmdma_start(struct ata_queued_cmd *qc)
3359 if (qc->ap->flags & ATA_FLAG_MMIO)
3360 ata_bmdma_start_mmio(qc);
3361 else
3362 ata_bmdma_start_pio(qc);
3367 * ata_bmdma_setup - Set up PCI IDE BMDMA transaction
3368 * @qc: Info associated with this ATA transaction.
3370 * Writes address of PRD table to device's PRD Table Address
3371 * register, sets the DMA control register, and calls
3372 * ops->exec_command() to start the transfer.
3374 * May be used as the bmdma_setup() entry in ata_port_operations.
3376 * LOCKING:
3377 * spin_lock_irqsave(host_set lock)
3379 void ata_bmdma_setup(struct ata_queued_cmd *qc)
3381 if (qc->ap->flags & ATA_FLAG_MMIO)
3382 ata_bmdma_setup_mmio(qc);
3383 else
3384 ata_bmdma_setup_pio(qc);
3389 * ata_bmdma_irq_clear - Clear PCI IDE BMDMA interrupt.
3390 * @ap: Port associated with this ATA transaction.
3392 * Clear interrupt and error flags in DMA status register.
3394 * May be used as the irq_clear() entry in ata_port_operations.
3396 * LOCKING:
3397 * spin_lock_irqsave(host_set lock)
3400 void ata_bmdma_irq_clear(struct ata_port *ap)
3402 if (ap->flags & ATA_FLAG_MMIO) {
3403 void __iomem *mmio = ((void __iomem *) ap->ioaddr.bmdma_addr) + ATA_DMA_STATUS;
3404 writeb(readb(mmio), mmio);
3405 } else {
3406 unsigned long addr = ap->ioaddr.bmdma_addr + ATA_DMA_STATUS;
3407 outb(inb(addr), addr);
3414 * ata_bmdma_status - Read PCI IDE BMDMA status
3415 * @ap: Port associated with this ATA transaction.
3417 * Read and return BMDMA status register.
3419 * May be used as the bmdma_status() entry in ata_port_operations.
3421 * LOCKING:
3422 * spin_lock_irqsave(host_set lock)
3425 u8 ata_bmdma_status(struct ata_port *ap)
3427 u8 host_stat;
3428 if (ap->flags & ATA_FLAG_MMIO) {
3429 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
3430 host_stat = readb(mmio + ATA_DMA_STATUS);
3431 } else
3432 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
3433 return host_stat;
3438 * ata_bmdma_stop - Stop PCI IDE BMDMA transfer
3439 * @ap: Port associated with this ATA transaction.
3441 * Clears the ATA_DMA_START flag in the dma control register
3443 * May be used as the bmdma_stop() entry in ata_port_operations.
3445 * LOCKING:
3446 * spin_lock_irqsave(host_set lock)
3449 void ata_bmdma_stop(struct ata_port *ap)
3451 if (ap->flags & ATA_FLAG_MMIO) {
3452 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
3454 /* clear start/stop bit */
3455 writeb(readb(mmio + ATA_DMA_CMD) & ~ATA_DMA_START,
3456 mmio + ATA_DMA_CMD);
3457 } else {
3458 /* clear start/stop bit */
3459 outb(inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD) & ~ATA_DMA_START,
3460 ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3463 /* one-PIO-cycle guaranteed wait, per spec, for HDMA1:0 transition */
3464 ata_altstatus(ap); /* dummy read */
3468 * ata_host_intr - Handle host interrupt for given (port, task)
3469 * @ap: Port on which interrupt arrived (possibly...)
3470 * @qc: Taskfile currently active in engine
3472 * Handle host interrupt for given queued command. Currently,
3473 * only DMA interrupts are handled. All other commands are
3474 * handled via polling with interrupts disabled (nIEN bit).
3476 * LOCKING:
3477 * spin_lock_irqsave(host_set lock)
3479 * RETURNS:
3480 * One if interrupt was handled, zero if not (shared irq).
3483 inline unsigned int ata_host_intr (struct ata_port *ap,
3484 struct ata_queued_cmd *qc)
3486 u8 status, host_stat;
3488 switch (qc->tf.protocol) {
3490 case ATA_PROT_DMA:
3491 case ATA_PROT_ATAPI_DMA:
3492 case ATA_PROT_ATAPI:
3493 /* check status of DMA engine */
3494 host_stat = ap->ops->bmdma_status(ap);
3495 VPRINTK("ata%u: host_stat 0x%X\n", ap->id, host_stat);
3497 /* if it's not our irq... */
3498 if (!(host_stat & ATA_DMA_INTR))
3499 goto idle_irq;
3501 /* before we do anything else, clear DMA-Start bit */
3502 ap->ops->bmdma_stop(ap);
3504 /* fall through */
3506 case ATA_PROT_ATAPI_NODATA:
3507 case ATA_PROT_NODATA:
3508 /* check altstatus */
3509 status = ata_altstatus(ap);
3510 if (status & ATA_BUSY)
3511 goto idle_irq;
3513 /* check main status, clearing INTRQ */
3514 status = ata_chk_status(ap);
3515 if (unlikely(status & ATA_BUSY))
3516 goto idle_irq;
3517 DPRINTK("ata%u: protocol %d (dev_stat 0x%X)\n",
3518 ap->id, qc->tf.protocol, status);
3520 /* ack bmdma irq events */
3521 ap->ops->irq_clear(ap);
3523 /* complete taskfile transaction */
3524 ata_qc_complete(qc, status);
3525 break;
3527 default:
3528 goto idle_irq;
3531 return 1; /* irq handled */
3533 idle_irq:
3534 ap->stats.idle_irq++;
3536 #ifdef ATA_IRQ_TRAP
3537 if ((ap->stats.idle_irq % 1000) == 0) {
3538 handled = 1;
3539 ata_irq_ack(ap, 0); /* debug trap */
3540 printk(KERN_WARNING "ata%d: irq trap\n", ap->id);
3542 #endif
3543 return 0; /* irq not handled */
3547 * ata_interrupt - Default ATA host interrupt handler
3548 * @irq: irq line (unused)
3549 * @dev_instance: pointer to our ata_host_set information structure
3550 * @regs: unused
3552 * Default interrupt handler for PCI IDE devices. Calls
3553 * ata_host_intr() for each port that is not disabled.
3555 * LOCKING:
3556 * Obtains host_set lock during operation.
3558 * RETURNS:
3559 * IRQ_NONE or IRQ_HANDLED.
3563 irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
3565 struct ata_host_set *host_set = dev_instance;
3566 unsigned int i;
3567 unsigned int handled = 0;
3568 unsigned long flags;
3570 /* TODO: make _irqsave conditional on x86 PCI IDE legacy mode */
3571 spin_lock_irqsave(&host_set->lock, flags);
3573 for (i = 0; i < host_set->n_ports; i++) {
3574 struct ata_port *ap;
3576 ap = host_set->ports[i];
3577 if (ap && (!(ap->flags & ATA_FLAG_PORT_DISABLED))) {
3578 struct ata_queued_cmd *qc;
3580 qc = ata_qc_from_tag(ap, ap->active_tag);
3581 if (qc && (!(qc->tf.ctl & ATA_NIEN)) &&
3582 (qc->flags & ATA_QCFLAG_ACTIVE))
3583 handled |= ata_host_intr(ap, qc);
3587 spin_unlock_irqrestore(&host_set->lock, flags);
3589 return IRQ_RETVAL(handled);
3593 * atapi_packet_task - Write CDB bytes to hardware
3594 * @_data: Port to which ATAPI device is attached.
3596 * When device has indicated its readiness to accept
3597 * a CDB, this function is called. Send the CDB.
3598 * If DMA is to be performed, exit immediately.
3599 * Otherwise, we are in polling mode, so poll
3600 * status under operation succeeds or fails.
3602 * LOCKING:
3603 * Kernel thread context (may sleep)
3606 static void atapi_packet_task(void *_data)
3608 struct ata_port *ap = _data;
3609 struct ata_queued_cmd *qc;
3610 u8 status;
3612 qc = ata_qc_from_tag(ap, ap->active_tag);
3613 assert(qc != NULL);
3614 assert(qc->flags & ATA_QCFLAG_ACTIVE);
3616 /* sleep-wait for BSY to clear */
3617 DPRINTK("busy wait\n");
3618 if (ata_busy_sleep(ap, ATA_TMOUT_CDB_QUICK, ATA_TMOUT_CDB))
3619 goto err_out;
3621 /* make sure DRQ is set */
3622 status = ata_chk_status(ap);
3623 if ((status & (ATA_BUSY | ATA_DRQ)) != ATA_DRQ)
3624 goto err_out;
3626 /* send SCSI cdb */
3627 DPRINTK("send cdb\n");
3628 assert(ap->cdb_len >= 12);
3629 ata_data_xfer(ap, qc->cdb, ap->cdb_len, 1);
3631 /* if we are DMA'ing, irq handler takes over from here */
3632 if (qc->tf.protocol == ATA_PROT_ATAPI_DMA)
3633 ap->ops->bmdma_start(qc); /* initiate bmdma */
3635 /* non-data commands are also handled via irq */
3636 else if (qc->tf.protocol == ATA_PROT_ATAPI_NODATA) {
3637 /* do nothing */
3640 /* PIO commands are handled by polling */
3641 else {
3642 ap->pio_task_state = PIO_ST;
3643 queue_work(ata_wq, &ap->pio_task);
3646 return;
3648 err_out:
3649 ata_qc_complete(qc, ATA_ERR);
3654 * ata_port_start - Set port up for dma.
3655 * @ap: Port to initialize
3657 * Called just after data structures for each port are
3658 * initialized. Allocates space for PRD table.
3660 * May be used as the port_start() entry in ata_port_operations.
3662 * LOCKING:
3665 int ata_port_start (struct ata_port *ap)
3667 struct device *dev = ap->host_set->dev;
3669 ap->prd = dma_alloc_coherent(dev, ATA_PRD_TBL_SZ, &ap->prd_dma, GFP_KERNEL);
3670 if (!ap->prd)
3671 return -ENOMEM;
3673 DPRINTK("prd alloc, virt %p, dma %llx\n", ap->prd, (unsigned long long) ap->prd_dma);
3675 return 0;
3680 * ata_port_stop - Undo ata_port_start()
3681 * @ap: Port to shut down
3683 * Frees the PRD table.
3685 * May be used as the port_stop() entry in ata_port_operations.
3687 * LOCKING:
3690 void ata_port_stop (struct ata_port *ap)
3692 struct device *dev = ap->host_set->dev;
3694 dma_free_coherent(dev, ATA_PRD_TBL_SZ, ap->prd, ap->prd_dma);
3697 void ata_host_stop (struct ata_host_set *host_set)
3699 if (host_set->mmio_base)
3700 iounmap(host_set->mmio_base);
3705 * ata_host_remove - Unregister SCSI host structure with upper layers
3706 * @ap: Port to unregister
3707 * @do_unregister: 1 if we fully unregister, 0 to just stop the port
3709 * LOCKING:
3712 static void ata_host_remove(struct ata_port *ap, unsigned int do_unregister)
3714 struct Scsi_Host *sh = ap->host;
3716 DPRINTK("ENTER\n");
3718 if (do_unregister)
3719 scsi_remove_host(sh);
3721 ap->ops->port_stop(ap);
3725 * ata_host_init - Initialize an ata_port structure
3726 * @ap: Structure to initialize
3727 * @host: associated SCSI mid-layer structure
3728 * @host_set: Collection of hosts to which @ap belongs
3729 * @ent: Probe information provided by low-level driver
3730 * @port_no: Port number associated with this ata_port
3732 * Initialize a new ata_port structure, and its associated
3733 * scsi_host.
3735 * LOCKING:
3736 * Inherited from caller.
3740 static void ata_host_init(struct ata_port *ap, struct Scsi_Host *host,
3741 struct ata_host_set *host_set,
3742 struct ata_probe_ent *ent, unsigned int port_no)
3744 unsigned int i;
3746 host->max_id = 16;
3747 host->max_lun = 1;
3748 host->max_channel = 1;
3749 host->unique_id = ata_unique_id++;
3750 host->max_cmd_len = 12;
3751 scsi_set_device(host, ent->dev);
3752 scsi_assign_lock(host, &host_set->lock);
3754 ap->flags = ATA_FLAG_PORT_DISABLED;
3755 ap->id = host->unique_id;
3756 ap->host = host;
3757 ap->ctl = ATA_DEVCTL_OBS;
3758 ap->host_set = host_set;
3759 ap->port_no = port_no;
3760 ap->hard_port_no =
3761 ent->legacy_mode ? ent->hard_port_no : port_no;
3762 ap->pio_mask = ent->pio_mask;
3763 ap->mwdma_mask = ent->mwdma_mask;
3764 ap->udma_mask = ent->udma_mask;
3765 ap->flags |= ent->host_flags;
3766 ap->ops = ent->port_ops;
3767 ap->cbl = ATA_CBL_NONE;
3768 ap->active_tag = ATA_TAG_POISON;
3769 ap->last_ctl = 0xFF;
3771 INIT_WORK(&ap->packet_task, atapi_packet_task, ap);
3772 INIT_WORK(&ap->pio_task, ata_pio_task, ap);
3774 for (i = 0; i < ATA_MAX_DEVICES; i++)
3775 ap->device[i].devno = i;
3777 #ifdef ATA_IRQ_TRAP
3778 ap->stats.unhandled_irq = 1;
3779 ap->stats.idle_irq = 1;
3780 #endif
3782 memcpy(&ap->ioaddr, &ent->port[port_no], sizeof(struct ata_ioports));
3786 * ata_host_add - Attach low-level ATA driver to system
3787 * @ent: Information provided by low-level driver
3788 * @host_set: Collections of ports to which we add
3789 * @port_no: Port number associated with this host
3791 * Attach low-level ATA driver to system.
3793 * LOCKING:
3794 * PCI/etc. bus probe sem.
3796 * RETURNS:
3797 * New ata_port on success, for NULL on error.
3801 static struct ata_port * ata_host_add(struct ata_probe_ent *ent,
3802 struct ata_host_set *host_set,
3803 unsigned int port_no)
3805 struct Scsi_Host *host;
3806 struct ata_port *ap;
3807 int rc;
3809 DPRINTK("ENTER\n");
3810 host = scsi_host_alloc(ent->sht, sizeof(struct ata_port));
3811 if (!host)
3812 return NULL;
3814 ap = (struct ata_port *) &host->hostdata[0];
3816 ata_host_init(ap, host, host_set, ent, port_no);
3818 rc = ap->ops->port_start(ap);
3819 if (rc)
3820 goto err_out;
3822 return ap;
3824 err_out:
3825 scsi_host_put(host);
3826 return NULL;
3830 * ata_device_add - Register hardware device with ATA and SCSI layers
3831 * @ent: Probe information describing hardware device to be registered
3833 * This function processes the information provided in the probe
3834 * information struct @ent, allocates the necessary ATA and SCSI
3835 * host information structures, initializes them, and registers
3836 * everything with requisite kernel subsystems.
3838 * This function requests irqs, probes the ATA bus, and probes
3839 * the SCSI bus.
3841 * LOCKING:
3842 * PCI/etc. bus probe sem.
3844 * RETURNS:
3845 * Number of ports registered. Zero on error (no ports registered).
3849 int ata_device_add(struct ata_probe_ent *ent)
3851 unsigned int count = 0, i;
3852 struct device *dev = ent->dev;
3853 struct ata_host_set *host_set;
3855 DPRINTK("ENTER\n");
3856 /* alloc a container for our list of ATA ports (buses) */
3857 host_set = kmalloc(sizeof(struct ata_host_set) +
3858 (ent->n_ports * sizeof(void *)), GFP_KERNEL);
3859 if (!host_set)
3860 return 0;
3861 memset(host_set, 0, sizeof(struct ata_host_set) + (ent->n_ports * sizeof(void *)));
3862 spin_lock_init(&host_set->lock);
3864 host_set->dev = dev;
3865 host_set->n_ports = ent->n_ports;
3866 host_set->irq = ent->irq;
3867 host_set->mmio_base = ent->mmio_base;
3868 host_set->private_data = ent->private_data;
3869 host_set->ops = ent->port_ops;
3871 /* register each port bound to this device */
3872 for (i = 0; i < ent->n_ports; i++) {
3873 struct ata_port *ap;
3874 unsigned long xfer_mode_mask;
3876 ap = ata_host_add(ent, host_set, i);
3877 if (!ap)
3878 goto err_out;
3880 host_set->ports[i] = ap;
3881 xfer_mode_mask =(ap->udma_mask << ATA_SHIFT_UDMA) |
3882 (ap->mwdma_mask << ATA_SHIFT_MWDMA) |
3883 (ap->pio_mask << ATA_SHIFT_PIO);
3885 /* print per-port info to dmesg */
3886 printk(KERN_INFO "ata%u: %cATA max %s cmd 0x%lX ctl 0x%lX "
3887 "bmdma 0x%lX irq %lu\n",
3888 ap->id,
3889 ap->flags & ATA_FLAG_SATA ? 'S' : 'P',
3890 ata_mode_string(xfer_mode_mask),
3891 ap->ioaddr.cmd_addr,
3892 ap->ioaddr.ctl_addr,
3893 ap->ioaddr.bmdma_addr,
3894 ent->irq);
3896 ata_chk_status(ap);
3897 host_set->ops->irq_clear(ap);
3898 count++;
3901 if (!count) {
3902 kfree(host_set);
3903 return 0;
3906 /* obtain irq, that is shared between channels */
3907 if (request_irq(ent->irq, ent->port_ops->irq_handler, ent->irq_flags,
3908 DRV_NAME, host_set))
3909 goto err_out;
3911 /* perform each probe synchronously */
3912 DPRINTK("probe begin\n");
3913 for (i = 0; i < count; i++) {
3914 struct ata_port *ap;
3915 int rc;
3917 ap = host_set->ports[i];
3919 DPRINTK("ata%u: probe begin\n", ap->id);
3920 rc = ata_bus_probe(ap);
3921 DPRINTK("ata%u: probe end\n", ap->id);
3923 if (rc) {
3924 /* FIXME: do something useful here?
3925 * Current libata behavior will
3926 * tear down everything when
3927 * the module is removed
3928 * or the h/w is unplugged.
3932 rc = scsi_add_host(ap->host, dev);
3933 if (rc) {
3934 printk(KERN_ERR "ata%u: scsi_add_host failed\n",
3935 ap->id);
3936 /* FIXME: do something useful here */
3937 /* FIXME: handle unconditional calls to
3938 * scsi_scan_host and ata_host_remove, below,
3939 * at the very least
3944 /* probes are done, now scan each port's disk(s) */
3945 DPRINTK("probe begin\n");
3946 for (i = 0; i < count; i++) {
3947 struct ata_port *ap = host_set->ports[i];
3949 scsi_scan_host(ap->host);
3952 dev_set_drvdata(dev, host_set);
3954 VPRINTK("EXIT, returning %u\n", ent->n_ports);
3955 return ent->n_ports; /* success */
3957 err_out:
3958 for (i = 0; i < count; i++) {
3959 ata_host_remove(host_set->ports[i], 1);
3960 scsi_host_put(host_set->ports[i]->host);
3962 kfree(host_set);
3963 VPRINTK("EXIT, returning 0\n");
3964 return 0;
3968 * ata_scsi_release - SCSI layer callback hook for host unload
3969 * @host: libata host to be unloaded
3971 * Performs all duties necessary to shut down a libata port...
3972 * Kill port kthread, disable port, and release resources.
3974 * LOCKING:
3975 * Inherited from SCSI layer.
3977 * RETURNS:
3978 * One.
3981 int ata_scsi_release(struct Scsi_Host *host)
3983 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
3985 DPRINTK("ENTER\n");
3987 ap->ops->port_disable(ap);
3988 ata_host_remove(ap, 0);
3990 DPRINTK("EXIT\n");
3991 return 1;
3995 * ata_std_ports - initialize ioaddr with standard port offsets.
3996 * @ioaddr: IO address structure to be initialized
3998 * Utility function which initializes data_addr, error_addr,
3999 * feature_addr, nsect_addr, lbal_addr, lbam_addr, lbah_addr,
4000 * device_addr, status_addr, and command_addr to standard offsets
4001 * relative to cmd_addr.
4003 * Does not set ctl_addr, altstatus_addr, bmdma_addr, or scr_addr.
4006 void ata_std_ports(struct ata_ioports *ioaddr)
4008 ioaddr->data_addr = ioaddr->cmd_addr + ATA_REG_DATA;
4009 ioaddr->error_addr = ioaddr->cmd_addr + ATA_REG_ERR;
4010 ioaddr->feature_addr = ioaddr->cmd_addr + ATA_REG_FEATURE;
4011 ioaddr->nsect_addr = ioaddr->cmd_addr + ATA_REG_NSECT;
4012 ioaddr->lbal_addr = ioaddr->cmd_addr + ATA_REG_LBAL;
4013 ioaddr->lbam_addr = ioaddr->cmd_addr + ATA_REG_LBAM;
4014 ioaddr->lbah_addr = ioaddr->cmd_addr + ATA_REG_LBAH;
4015 ioaddr->device_addr = ioaddr->cmd_addr + ATA_REG_DEVICE;
4016 ioaddr->status_addr = ioaddr->cmd_addr + ATA_REG_STATUS;
4017 ioaddr->command_addr = ioaddr->cmd_addr + ATA_REG_CMD;
4020 static struct ata_probe_ent *
4021 ata_probe_ent_alloc(struct device *dev, struct ata_port_info *port)
4023 struct ata_probe_ent *probe_ent;
4025 probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
4026 if (!probe_ent) {
4027 printk(KERN_ERR DRV_NAME "(%s): out of memory\n",
4028 kobject_name(&(dev->kobj)));
4029 return NULL;
4032 memset(probe_ent, 0, sizeof(*probe_ent));
4034 INIT_LIST_HEAD(&probe_ent->node);
4035 probe_ent->dev = dev;
4037 probe_ent->sht = port->sht;
4038 probe_ent->host_flags = port->host_flags;
4039 probe_ent->pio_mask = port->pio_mask;
4040 probe_ent->mwdma_mask = port->mwdma_mask;
4041 probe_ent->udma_mask = port->udma_mask;
4042 probe_ent->port_ops = port->port_ops;
4044 return probe_ent;
4050 * ata_pci_init_native_mode - Initialize native-mode driver
4051 * @pdev: pci device to be initialized
4052 * @port: array[2] of pointers to port info structures.
4054 * Utility function which allocates and initializes an
4055 * ata_probe_ent structure for a standard dual-port
4056 * PIO-based IDE controller. The returned ata_probe_ent
4057 * structure can be passed to ata_device_add(). The returned
4058 * ata_probe_ent structure should then be freed with kfree().
4061 #ifdef CONFIG_PCI
4062 struct ata_probe_ent *
4063 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port)
4065 struct ata_probe_ent *probe_ent =
4066 ata_probe_ent_alloc(pci_dev_to_dev(pdev), port[0]);
4067 if (!probe_ent)
4068 return NULL;
4070 probe_ent->n_ports = 2;
4071 probe_ent->irq = pdev->irq;
4072 probe_ent->irq_flags = SA_SHIRQ;
4074 probe_ent->port[0].cmd_addr = pci_resource_start(pdev, 0);
4075 probe_ent->port[0].altstatus_addr =
4076 probe_ent->port[0].ctl_addr =
4077 pci_resource_start(pdev, 1) | ATA_PCI_CTL_OFS;
4078 probe_ent->port[0].bmdma_addr = pci_resource_start(pdev, 4);
4080 probe_ent->port[1].cmd_addr = pci_resource_start(pdev, 2);
4081 probe_ent->port[1].altstatus_addr =
4082 probe_ent->port[1].ctl_addr =
4083 pci_resource_start(pdev, 3) | ATA_PCI_CTL_OFS;
4084 probe_ent->port[1].bmdma_addr = pci_resource_start(pdev, 4) + 8;
4086 ata_std_ports(&probe_ent->port[0]);
4087 ata_std_ports(&probe_ent->port[1]);
4089 return probe_ent;
4092 static struct ata_probe_ent *
4093 ata_pci_init_legacy_mode(struct pci_dev *pdev, struct ata_port_info **port,
4094 struct ata_probe_ent **ppe2)
4096 struct ata_probe_ent *probe_ent, *probe_ent2;
4098 probe_ent = ata_probe_ent_alloc(pci_dev_to_dev(pdev), port[0]);
4099 if (!probe_ent)
4100 return NULL;
4101 probe_ent2 = ata_probe_ent_alloc(pci_dev_to_dev(pdev), port[1]);
4102 if (!probe_ent2) {
4103 kfree(probe_ent);
4104 return NULL;
4107 probe_ent->n_ports = 1;
4108 probe_ent->irq = 14;
4110 probe_ent->hard_port_no = 0;
4111 probe_ent->legacy_mode = 1;
4113 probe_ent2->n_ports = 1;
4114 probe_ent2->irq = 15;
4116 probe_ent2->hard_port_no = 1;
4117 probe_ent2->legacy_mode = 1;
4119 probe_ent->port[0].cmd_addr = 0x1f0;
4120 probe_ent->port[0].altstatus_addr =
4121 probe_ent->port[0].ctl_addr = 0x3f6;
4122 probe_ent->port[0].bmdma_addr = pci_resource_start(pdev, 4);
4124 probe_ent2->port[0].cmd_addr = 0x170;
4125 probe_ent2->port[0].altstatus_addr =
4126 probe_ent2->port[0].ctl_addr = 0x376;
4127 probe_ent2->port[0].bmdma_addr = pci_resource_start(pdev, 4)+8;
4129 ata_std_ports(&probe_ent->port[0]);
4130 ata_std_ports(&probe_ent2->port[0]);
4132 *ppe2 = probe_ent2;
4133 return probe_ent;
4137 * ata_pci_init_one - Initialize/register PCI IDE host controller
4138 * @pdev: Controller to be initialized
4139 * @port_info: Information from low-level host driver
4140 * @n_ports: Number of ports attached to host controller
4142 * This is a helper function which can be called from a driver's
4143 * xxx_init_one() probe function if the hardware uses traditional
4144 * IDE taskfile registers.
4146 * This function calls pci_enable_device(), reserves its register
4147 * regions, sets the dma mask, enables bus master mode, and calls
4148 * ata_device_add()
4150 * LOCKING:
4151 * Inherited from PCI layer (may sleep).
4153 * RETURNS:
4154 * Zero on success, negative on errno-based value on error.
4158 int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
4159 unsigned int n_ports)
4161 struct ata_probe_ent *probe_ent, *probe_ent2 = NULL;
4162 struct ata_port_info *port[2];
4163 u8 tmp8, mask;
4164 unsigned int legacy_mode = 0;
4165 int disable_dev_on_err = 1;
4166 int rc;
4168 DPRINTK("ENTER\n");
4170 port[0] = port_info[0];
4171 if (n_ports > 1)
4172 port[1] = port_info[1];
4173 else
4174 port[1] = port[0];
4176 if ((port[0]->host_flags & ATA_FLAG_NO_LEGACY) == 0
4177 && (pdev->class >> 8) == PCI_CLASS_STORAGE_IDE) {
4178 /* TODO: support transitioning to native mode? */
4179 pci_read_config_byte(pdev, PCI_CLASS_PROG, &tmp8);
4180 mask = (1 << 2) | (1 << 0);
4181 if ((tmp8 & mask) != mask)
4182 legacy_mode = (1 << 3);
4185 /* FIXME... */
4186 if ((!legacy_mode) && (n_ports > 1)) {
4187 printk(KERN_ERR "ata: BUG: native mode, n_ports > 1\n");
4188 return -EINVAL;
4191 rc = pci_enable_device(pdev);
4192 if (rc)
4193 return rc;
4195 rc = pci_request_regions(pdev, DRV_NAME);
4196 if (rc) {
4197 disable_dev_on_err = 0;
4198 goto err_out;
4201 if (legacy_mode) {
4202 if (!request_region(0x1f0, 8, "libata")) {
4203 struct resource *conflict, res;
4204 res.start = 0x1f0;
4205 res.end = 0x1f0 + 8 - 1;
4206 conflict = ____request_resource(&ioport_resource, &res);
4207 if (!strcmp(conflict->name, "libata"))
4208 legacy_mode |= (1 << 0);
4209 else {
4210 disable_dev_on_err = 0;
4211 printk(KERN_WARNING "ata: 0x1f0 IDE port busy\n");
4213 } else
4214 legacy_mode |= (1 << 0);
4216 if (!request_region(0x170, 8, "libata")) {
4217 struct resource *conflict, res;
4218 res.start = 0x170;
4219 res.end = 0x170 + 8 - 1;
4220 conflict = ____request_resource(&ioport_resource, &res);
4221 if (!strcmp(conflict->name, "libata"))
4222 legacy_mode |= (1 << 1);
4223 else {
4224 disable_dev_on_err = 0;
4225 printk(KERN_WARNING "ata: 0x170 IDE port busy\n");
4227 } else
4228 legacy_mode |= (1 << 1);
4231 /* we have legacy mode, but all ports are unavailable */
4232 if (legacy_mode == (1 << 3)) {
4233 rc = -EBUSY;
4234 goto err_out_regions;
4237 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
4238 if (rc)
4239 goto err_out_regions;
4240 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
4241 if (rc)
4242 goto err_out_regions;
4244 if (legacy_mode) {
4245 probe_ent = ata_pci_init_legacy_mode(pdev, port, &probe_ent2);
4246 } else
4247 probe_ent = ata_pci_init_native_mode(pdev, port);
4248 if (!probe_ent) {
4249 rc = -ENOMEM;
4250 goto err_out_regions;
4253 pci_set_master(pdev);
4255 /* FIXME: check ata_device_add return */
4256 if (legacy_mode) {
4257 if (legacy_mode & (1 << 0))
4258 ata_device_add(probe_ent);
4259 if (legacy_mode & (1 << 1))
4260 ata_device_add(probe_ent2);
4261 } else
4262 ata_device_add(probe_ent);
4264 kfree(probe_ent);
4265 kfree(probe_ent2);
4267 return 0;
4269 err_out_regions:
4270 if (legacy_mode & (1 << 0))
4271 release_region(0x1f0, 8);
4272 if (legacy_mode & (1 << 1))
4273 release_region(0x170, 8);
4274 pci_release_regions(pdev);
4275 err_out:
4276 if (disable_dev_on_err)
4277 pci_disable_device(pdev);
4278 return rc;
4282 * ata_pci_remove_one - PCI layer callback for device removal
4283 * @pdev: PCI device that was removed
4285 * PCI layer indicates to libata via this hook that
4286 * hot-unplug or module unload event has occured.
4287 * Handle this by unregistering all objects associated
4288 * with this PCI device. Free those objects. Then finally
4289 * release PCI resources and disable device.
4291 * LOCKING:
4292 * Inherited from PCI layer (may sleep).
4295 void ata_pci_remove_one (struct pci_dev *pdev)
4297 struct device *dev = pci_dev_to_dev(pdev);
4298 struct ata_host_set *host_set = dev_get_drvdata(dev);
4299 struct ata_port *ap;
4300 unsigned int i;
4302 for (i = 0; i < host_set->n_ports; i++) {
4303 ap = host_set->ports[i];
4305 scsi_remove_host(ap->host);
4308 free_irq(host_set->irq, host_set);
4310 for (i = 0; i < host_set->n_ports; i++) {
4311 ap = host_set->ports[i];
4313 ata_scsi_release(ap->host);
4315 if ((ap->flags & ATA_FLAG_NO_LEGACY) == 0) {
4316 struct ata_ioports *ioaddr = &ap->ioaddr;
4318 if (ioaddr->cmd_addr == 0x1f0)
4319 release_region(0x1f0, 8);
4320 else if (ioaddr->cmd_addr == 0x170)
4321 release_region(0x170, 8);
4324 scsi_host_put(ap->host);
4327 if (host_set->ops->host_stop)
4328 host_set->ops->host_stop(host_set);
4330 kfree(host_set);
4332 pci_release_regions(pdev);
4333 pci_disable_device(pdev);
4334 dev_set_drvdata(dev, NULL);
4337 /* move to PCI subsystem */
4338 int pci_test_config_bits(struct pci_dev *pdev, struct pci_bits *bits)
4340 unsigned long tmp = 0;
4342 switch (bits->width) {
4343 case 1: {
4344 u8 tmp8 = 0;
4345 pci_read_config_byte(pdev, bits->reg, &tmp8);
4346 tmp = tmp8;
4347 break;
4349 case 2: {
4350 u16 tmp16 = 0;
4351 pci_read_config_word(pdev, bits->reg, &tmp16);
4352 tmp = tmp16;
4353 break;
4355 case 4: {
4356 u32 tmp32 = 0;
4357 pci_read_config_dword(pdev, bits->reg, &tmp32);
4358 tmp = tmp32;
4359 break;
4362 default:
4363 return -EINVAL;
4366 tmp &= bits->mask;
4368 return (tmp == bits->val) ? 1 : 0;
4370 #endif /* CONFIG_PCI */
4373 static int __init ata_init(void)
4375 ata_wq = create_workqueue("ata");
4376 if (!ata_wq)
4377 return -ENOMEM;
4379 printk(KERN_DEBUG "libata version " DRV_VERSION " loaded.\n");
4380 return 0;
4383 static void __exit ata_exit(void)
4385 destroy_workqueue(ata_wq);
4388 module_init(ata_init);
4389 module_exit(ata_exit);
4392 * libata is essentially a library of internal helper functions for
4393 * low-level ATA host controller drivers. As such, the API/ABI is
4394 * likely to change as new drivers are added and updated.
4395 * Do not depend on ABI/API stability.
4398 EXPORT_SYMBOL_GPL(ata_std_bios_param);
4399 EXPORT_SYMBOL_GPL(ata_std_ports);
4400 EXPORT_SYMBOL_GPL(ata_device_add);
4401 EXPORT_SYMBOL_GPL(ata_sg_init);
4402 EXPORT_SYMBOL_GPL(ata_sg_init_one);
4403 EXPORT_SYMBOL_GPL(ata_qc_complete);
4404 EXPORT_SYMBOL_GPL(ata_qc_issue_prot);
4405 EXPORT_SYMBOL_GPL(ata_eng_timeout);
4406 EXPORT_SYMBOL_GPL(ata_tf_load);
4407 EXPORT_SYMBOL_GPL(ata_tf_read);
4408 EXPORT_SYMBOL_GPL(ata_noop_dev_select);
4409 EXPORT_SYMBOL_GPL(ata_std_dev_select);
4410 EXPORT_SYMBOL_GPL(ata_tf_to_fis);
4411 EXPORT_SYMBOL_GPL(ata_tf_from_fis);
4412 EXPORT_SYMBOL_GPL(ata_check_status);
4413 EXPORT_SYMBOL_GPL(ata_altstatus);
4414 EXPORT_SYMBOL_GPL(ata_chk_err);
4415 EXPORT_SYMBOL_GPL(ata_exec_command);
4416 EXPORT_SYMBOL_GPL(ata_port_start);
4417 EXPORT_SYMBOL_GPL(ata_port_stop);
4418 EXPORT_SYMBOL_GPL(ata_host_stop);
4419 EXPORT_SYMBOL_GPL(ata_interrupt);
4420 EXPORT_SYMBOL_GPL(ata_qc_prep);
4421 EXPORT_SYMBOL_GPL(ata_bmdma_setup);
4422 EXPORT_SYMBOL_GPL(ata_bmdma_start);
4423 EXPORT_SYMBOL_GPL(ata_bmdma_irq_clear);
4424 EXPORT_SYMBOL_GPL(ata_bmdma_status);
4425 EXPORT_SYMBOL_GPL(ata_bmdma_stop);
4426 EXPORT_SYMBOL_GPL(ata_port_probe);
4427 EXPORT_SYMBOL_GPL(sata_phy_reset);
4428 EXPORT_SYMBOL_GPL(__sata_phy_reset);
4429 EXPORT_SYMBOL_GPL(ata_bus_reset);
4430 EXPORT_SYMBOL_GPL(ata_port_disable);
4431 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
4432 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
4433 EXPORT_SYMBOL_GPL(ata_scsi_error);
4434 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
4435 EXPORT_SYMBOL_GPL(ata_scsi_release);
4436 EXPORT_SYMBOL_GPL(ata_host_intr);
4437 EXPORT_SYMBOL_GPL(ata_dev_classify);
4438 EXPORT_SYMBOL_GPL(ata_dev_id_string);
4439 EXPORT_SYMBOL_GPL(ata_dev_config);
4440 EXPORT_SYMBOL_GPL(ata_scsi_simulate);
4442 #ifdef CONFIG_PCI
4443 EXPORT_SYMBOL_GPL(pci_test_config_bits);
4444 EXPORT_SYMBOL_GPL(ata_pci_init_native_mode);
4445 EXPORT_SYMBOL_GPL(ata_pci_init_one);
4446 EXPORT_SYMBOL_GPL(ata_pci_remove_one);
4447 #endif /* CONFIG_PCI */