2 * libata-core.c - helper library for ATA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available from http://www.t13.org/ and
31 * http://www.sata-io.org/
35 #include <linux/config.h>
36 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/pci.h>
39 #include <linux/init.h>
40 #include <linux/list.h>
42 #include <linux/highmem.h>
43 #include <linux/spinlock.h>
44 #include <linux/blkdev.h>
45 #include <linux/delay.h>
46 #include <linux/timer.h>
47 #include <linux/interrupt.h>
48 #include <linux/completion.h>
49 #include <linux/suspend.h>
50 #include <linux/workqueue.h>
51 #include <linux/jiffies.h>
52 #include <linux/scatterlist.h>
53 #include <scsi/scsi.h>
54 #include "scsi_priv.h"
55 #include <scsi/scsi_cmnd.h>
56 #include <scsi/scsi_host.h>
57 #include <linux/libata.h>
59 #include <asm/semaphore.h>
60 #include <asm/byteorder.h>
64 static unsigned int ata_busy_sleep (struct ata_port *ap,
65 unsigned long tmout_pat,
67 static void ata_dev_reread_id(struct ata_port *ap, struct ata_device *dev);
68 static void ata_dev_init_params(struct ata_port *ap, struct ata_device *dev);
69 static void ata_set_mode(struct ata_port *ap);
70 static void ata_dev_set_xfermode(struct ata_port *ap, struct ata_device *dev);
71 static unsigned int ata_get_mode_mask(const struct ata_port *ap, int shift);
72 static int fgb(u32 bitmap);
73 static int ata_choose_xfer_mode(const struct ata_port *ap,
75 unsigned int *xfer_shift_out);
76 static void __ata_qc_complete(struct ata_queued_cmd *qc);
78 static unsigned int ata_unique_id = 1;
79 static struct workqueue_struct *ata_wq;
81 int atapi_enabled = 0;
82 module_param(atapi_enabled, int, 0444);
83 MODULE_PARM_DESC(atapi_enabled, "Enable discovery of ATAPI devices (0=off, 1=on)");
85 MODULE_AUTHOR("Jeff Garzik");
86 MODULE_DESCRIPTION("Library module for ATA devices");
87 MODULE_LICENSE("GPL");
88 MODULE_VERSION(DRV_VERSION);
91 * ata_tf_load_pio - send taskfile registers to host controller
92 * @ap: Port to which output is sent
93 * @tf: ATA taskfile register set
95 * Outputs ATA taskfile to standard ATA host controller.
98 * Inherited from caller.
101 static void ata_tf_load_pio(struct ata_port *ap, const struct ata_taskfile *tf)
103 struct ata_ioports *ioaddr = &ap->ioaddr;
104 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
106 if (tf->ctl != ap->last_ctl) {
107 outb(tf->ctl, ioaddr->ctl_addr);
108 ap->last_ctl = tf->ctl;
112 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
113 outb(tf->hob_feature, ioaddr->feature_addr);
114 outb(tf->hob_nsect, ioaddr->nsect_addr);
115 outb(tf->hob_lbal, ioaddr->lbal_addr);
116 outb(tf->hob_lbam, ioaddr->lbam_addr);
117 outb(tf->hob_lbah, ioaddr->lbah_addr);
118 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
127 outb(tf->feature, ioaddr->feature_addr);
128 outb(tf->nsect, ioaddr->nsect_addr);
129 outb(tf->lbal, ioaddr->lbal_addr);
130 outb(tf->lbam, ioaddr->lbam_addr);
131 outb(tf->lbah, ioaddr->lbah_addr);
132 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
140 if (tf->flags & ATA_TFLAG_DEVICE) {
141 outb(tf->device, ioaddr->device_addr);
142 VPRINTK("device 0x%X\n", tf->device);
149 * ata_tf_load_mmio - send taskfile registers to host controller
150 * @ap: Port to which output is sent
151 * @tf: ATA taskfile register set
153 * Outputs ATA taskfile to standard ATA host controller using MMIO.
156 * Inherited from caller.
159 static void ata_tf_load_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
161 struct ata_ioports *ioaddr = &ap->ioaddr;
162 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
164 if (tf->ctl != ap->last_ctl) {
165 writeb(tf->ctl, (void __iomem *) ap->ioaddr.ctl_addr);
166 ap->last_ctl = tf->ctl;
170 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
171 writeb(tf->hob_feature, (void __iomem *) ioaddr->feature_addr);
172 writeb(tf->hob_nsect, (void __iomem *) ioaddr->nsect_addr);
173 writeb(tf->hob_lbal, (void __iomem *) ioaddr->lbal_addr);
174 writeb(tf->hob_lbam, (void __iomem *) ioaddr->lbam_addr);
175 writeb(tf->hob_lbah, (void __iomem *) ioaddr->lbah_addr);
176 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
185 writeb(tf->feature, (void __iomem *) ioaddr->feature_addr);
186 writeb(tf->nsect, (void __iomem *) ioaddr->nsect_addr);
187 writeb(tf->lbal, (void __iomem *) ioaddr->lbal_addr);
188 writeb(tf->lbam, (void __iomem *) ioaddr->lbam_addr);
189 writeb(tf->lbah, (void __iomem *) ioaddr->lbah_addr);
190 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
198 if (tf->flags & ATA_TFLAG_DEVICE) {
199 writeb(tf->device, (void __iomem *) ioaddr->device_addr);
200 VPRINTK("device 0x%X\n", tf->device);
208 * ata_tf_load - send taskfile registers to host controller
209 * @ap: Port to which output is sent
210 * @tf: ATA taskfile register set
212 * Outputs ATA taskfile to standard ATA host controller using MMIO
213 * or PIO as indicated by the ATA_FLAG_MMIO flag.
214 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
215 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
216 * hob_lbal, hob_lbam, and hob_lbah.
218 * This function waits for idle (!BUSY and !DRQ) after writing
219 * registers. If the control register has a new value, this
220 * function also waits for idle after writing control and before
221 * writing the remaining registers.
223 * May be used as the tf_load() entry in ata_port_operations.
226 * Inherited from caller.
228 void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf)
230 if (ap->flags & ATA_FLAG_MMIO)
231 ata_tf_load_mmio(ap, tf);
233 ata_tf_load_pio(ap, tf);
237 * ata_exec_command_pio - issue ATA command to host controller
238 * @ap: port to which command is being issued
239 * @tf: ATA taskfile register set
241 * Issues PIO write to ATA command register, with proper
242 * synchronization with interrupt handler / other threads.
245 * spin_lock_irqsave(host_set lock)
248 static void ata_exec_command_pio(struct ata_port *ap, const struct ata_taskfile *tf)
250 DPRINTK("ata%u: cmd 0x%X\n", ap->id, tf->command);
252 outb(tf->command, ap->ioaddr.command_addr);
258 * ata_exec_command_mmio - issue ATA command to host controller
259 * @ap: port to which command is being issued
260 * @tf: ATA taskfile register set
262 * Issues MMIO write to ATA command register, with proper
263 * synchronization with interrupt handler / other threads.
266 * spin_lock_irqsave(host_set lock)
269 static void ata_exec_command_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
271 DPRINTK("ata%u: cmd 0x%X\n", ap->id, tf->command);
273 writeb(tf->command, (void __iomem *) ap->ioaddr.command_addr);
279 * ata_exec_command - issue ATA command to host controller
280 * @ap: port to which command is being issued
281 * @tf: ATA taskfile register set
283 * Issues PIO/MMIO write to ATA command register, with proper
284 * synchronization with interrupt handler / other threads.
287 * spin_lock_irqsave(host_set lock)
289 void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf)
291 if (ap->flags & ATA_FLAG_MMIO)
292 ata_exec_command_mmio(ap, tf);
294 ata_exec_command_pio(ap, tf);
298 * ata_tf_to_host - issue ATA taskfile to host controller
299 * @ap: port to which command is being issued
300 * @tf: ATA taskfile register set
302 * Issues ATA taskfile register set to ATA host controller,
303 * with proper synchronization with interrupt handler and
307 * spin_lock_irqsave(host_set lock)
310 static inline void ata_tf_to_host(struct ata_port *ap,
311 const struct ata_taskfile *tf)
313 ap->ops->tf_load(ap, tf);
314 ap->ops->exec_command(ap, tf);
318 * ata_tf_read_pio - input device's ATA taskfile shadow registers
319 * @ap: Port from which input is read
320 * @tf: ATA taskfile register set for storing input
322 * Reads ATA taskfile registers for currently-selected device
326 * Inherited from caller.
329 static void ata_tf_read_pio(struct ata_port *ap, struct ata_taskfile *tf)
331 struct ata_ioports *ioaddr = &ap->ioaddr;
333 tf->command = ata_check_status(ap);
334 tf->feature = inb(ioaddr->error_addr);
335 tf->nsect = inb(ioaddr->nsect_addr);
336 tf->lbal = inb(ioaddr->lbal_addr);
337 tf->lbam = inb(ioaddr->lbam_addr);
338 tf->lbah = inb(ioaddr->lbah_addr);
339 tf->device = inb(ioaddr->device_addr);
341 if (tf->flags & ATA_TFLAG_LBA48) {
342 outb(tf->ctl | ATA_HOB, ioaddr->ctl_addr);
343 tf->hob_feature = inb(ioaddr->error_addr);
344 tf->hob_nsect = inb(ioaddr->nsect_addr);
345 tf->hob_lbal = inb(ioaddr->lbal_addr);
346 tf->hob_lbam = inb(ioaddr->lbam_addr);
347 tf->hob_lbah = inb(ioaddr->lbah_addr);
352 * ata_tf_read_mmio - input device's ATA taskfile shadow registers
353 * @ap: Port from which input is read
354 * @tf: ATA taskfile register set for storing input
356 * Reads ATA taskfile registers for currently-selected device
360 * Inherited from caller.
363 static void ata_tf_read_mmio(struct ata_port *ap, struct ata_taskfile *tf)
365 struct ata_ioports *ioaddr = &ap->ioaddr;
367 tf->command = ata_check_status(ap);
368 tf->feature = readb((void __iomem *)ioaddr->error_addr);
369 tf->nsect = readb((void __iomem *)ioaddr->nsect_addr);
370 tf->lbal = readb((void __iomem *)ioaddr->lbal_addr);
371 tf->lbam = readb((void __iomem *)ioaddr->lbam_addr);
372 tf->lbah = readb((void __iomem *)ioaddr->lbah_addr);
373 tf->device = readb((void __iomem *)ioaddr->device_addr);
375 if (tf->flags & ATA_TFLAG_LBA48) {
376 writeb(tf->ctl | ATA_HOB, (void __iomem *) ap->ioaddr.ctl_addr);
377 tf->hob_feature = readb((void __iomem *)ioaddr->error_addr);
378 tf->hob_nsect = readb((void __iomem *)ioaddr->nsect_addr);
379 tf->hob_lbal = readb((void __iomem *)ioaddr->lbal_addr);
380 tf->hob_lbam = readb((void __iomem *)ioaddr->lbam_addr);
381 tf->hob_lbah = readb((void __iomem *)ioaddr->lbah_addr);
387 * ata_tf_read - input device's ATA taskfile shadow registers
388 * @ap: Port from which input is read
389 * @tf: ATA taskfile register set for storing input
391 * Reads ATA taskfile registers for currently-selected device
394 * Reads nsect, lbal, lbam, lbah, and device. If ATA_TFLAG_LBA48
395 * is set, also reads the hob registers.
397 * May be used as the tf_read() entry in ata_port_operations.
400 * Inherited from caller.
402 void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
404 if (ap->flags & ATA_FLAG_MMIO)
405 ata_tf_read_mmio(ap, tf);
407 ata_tf_read_pio(ap, tf);
411 * ata_check_status_pio - Read device status reg & clear interrupt
412 * @ap: port where the device is
414 * Reads ATA taskfile status register for currently-selected device
415 * and return its value. This also clears pending interrupts
419 * Inherited from caller.
421 static u8 ata_check_status_pio(struct ata_port *ap)
423 return inb(ap->ioaddr.status_addr);
427 * ata_check_status_mmio - Read device status reg & clear interrupt
428 * @ap: port where the device is
430 * Reads ATA taskfile status register for currently-selected device
431 * via MMIO and return its value. This also clears pending interrupts
435 * Inherited from caller.
437 static u8 ata_check_status_mmio(struct ata_port *ap)
439 return readb((void __iomem *) ap->ioaddr.status_addr);
444 * ata_check_status - Read device status reg & clear interrupt
445 * @ap: port where the device is
447 * Reads ATA taskfile status register for currently-selected device
448 * and return its value. This also clears pending interrupts
451 * May be used as the check_status() entry in ata_port_operations.
454 * Inherited from caller.
456 u8 ata_check_status(struct ata_port *ap)
458 if (ap->flags & ATA_FLAG_MMIO)
459 return ata_check_status_mmio(ap);
460 return ata_check_status_pio(ap);
465 * ata_altstatus - Read device alternate status reg
466 * @ap: port where the device is
468 * Reads ATA taskfile alternate status register for
469 * currently-selected device and return its value.
471 * Note: may NOT be used as the check_altstatus() entry in
472 * ata_port_operations.
475 * Inherited from caller.
477 u8 ata_altstatus(struct ata_port *ap)
479 if (ap->ops->check_altstatus)
480 return ap->ops->check_altstatus(ap);
482 if (ap->flags & ATA_FLAG_MMIO)
483 return readb((void __iomem *)ap->ioaddr.altstatus_addr);
484 return inb(ap->ioaddr.altstatus_addr);
489 * ata_tf_to_fis - Convert ATA taskfile to SATA FIS structure
490 * @tf: Taskfile to convert
491 * @fis: Buffer into which data will output
492 * @pmp: Port multiplier port
494 * Converts a standard ATA taskfile to a Serial ATA
495 * FIS structure (Register - Host to Device).
498 * Inherited from caller.
501 void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp)
503 fis[0] = 0x27; /* Register - Host to Device FIS */
504 fis[1] = (pmp & 0xf) | (1 << 7); /* Port multiplier number,
505 bit 7 indicates Command FIS */
506 fis[2] = tf->command;
507 fis[3] = tf->feature;
514 fis[8] = tf->hob_lbal;
515 fis[9] = tf->hob_lbam;
516 fis[10] = tf->hob_lbah;
517 fis[11] = tf->hob_feature;
520 fis[13] = tf->hob_nsect;
531 * ata_tf_from_fis - Convert SATA FIS to ATA taskfile
532 * @fis: Buffer from which data will be input
533 * @tf: Taskfile to output
535 * Converts a serial ATA FIS structure to a standard ATA taskfile.
538 * Inherited from caller.
541 void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf)
543 tf->command = fis[2]; /* status */
544 tf->feature = fis[3]; /* error */
551 tf->hob_lbal = fis[8];
552 tf->hob_lbam = fis[9];
553 tf->hob_lbah = fis[10];
556 tf->hob_nsect = fis[13];
559 static const u8 ata_rw_cmds[] = {
563 ATA_CMD_READ_MULTI_EXT,
564 ATA_CMD_WRITE_MULTI_EXT,
568 ATA_CMD_PIO_READ_EXT,
569 ATA_CMD_PIO_WRITE_EXT,
578 * ata_rwcmd_protocol - set taskfile r/w commands and protocol
579 * @qc: command to examine and configure
581 * Examine the device configuration and tf->flags to calculate
582 * the proper read/write commands and protocol to use.
587 void ata_rwcmd_protocol(struct ata_queued_cmd *qc)
589 struct ata_taskfile *tf = &qc->tf;
590 struct ata_device *dev = qc->dev;
592 int index, lba48, write;
594 lba48 = (tf->flags & ATA_TFLAG_LBA48) ? 2 : 0;
595 write = (tf->flags & ATA_TFLAG_WRITE) ? 1 : 0;
597 if (dev->flags & ATA_DFLAG_PIO) {
598 tf->protocol = ATA_PROT_PIO;
599 index = dev->multi_count ? 0 : 4;
601 tf->protocol = ATA_PROT_DMA;
605 tf->command = ata_rw_cmds[index + lba48 + write];
608 static const char * const xfer_mode_str[] = {
628 * ata_udma_string - convert UDMA bit offset to string
629 * @mask: mask of bits supported; only highest bit counts.
631 * Determine string which represents the highest speed
632 * (highest bit in @udma_mask).
638 * Constant C string representing highest speed listed in
639 * @udma_mask, or the constant C string "<n/a>".
642 static const char *ata_mode_string(unsigned int mask)
646 for (i = 7; i >= 0; i--)
649 for (i = ATA_SHIFT_MWDMA + 2; i >= ATA_SHIFT_MWDMA; i--)
652 for (i = ATA_SHIFT_PIO + 4; i >= ATA_SHIFT_PIO; i--)
659 return xfer_mode_str[i];
663 * ata_pio_devchk - PATA device presence detection
664 * @ap: ATA channel to examine
665 * @device: Device to examine (starting at zero)
667 * This technique was originally described in
668 * Hale Landis's ATADRVR (www.ata-atapi.com), and
669 * later found its way into the ATA/ATAPI spec.
671 * Write a pattern to the ATA shadow registers,
672 * and if a device is present, it will respond by
673 * correctly storing and echoing back the
674 * ATA shadow register contents.
680 static unsigned int ata_pio_devchk(struct ata_port *ap,
683 struct ata_ioports *ioaddr = &ap->ioaddr;
686 ap->ops->dev_select(ap, device);
688 outb(0x55, ioaddr->nsect_addr);
689 outb(0xaa, ioaddr->lbal_addr);
691 outb(0xaa, ioaddr->nsect_addr);
692 outb(0x55, ioaddr->lbal_addr);
694 outb(0x55, ioaddr->nsect_addr);
695 outb(0xaa, ioaddr->lbal_addr);
697 nsect = inb(ioaddr->nsect_addr);
698 lbal = inb(ioaddr->lbal_addr);
700 if ((nsect == 0x55) && (lbal == 0xaa))
701 return 1; /* we found a device */
703 return 0; /* nothing found */
707 * ata_mmio_devchk - PATA device presence detection
708 * @ap: ATA channel to examine
709 * @device: Device to examine (starting at zero)
711 * This technique was originally described in
712 * Hale Landis's ATADRVR (www.ata-atapi.com), and
713 * later found its way into the ATA/ATAPI spec.
715 * Write a pattern to the ATA shadow registers,
716 * and if a device is present, it will respond by
717 * correctly storing and echoing back the
718 * ATA shadow register contents.
724 static unsigned int ata_mmio_devchk(struct ata_port *ap,
727 struct ata_ioports *ioaddr = &ap->ioaddr;
730 ap->ops->dev_select(ap, device);
732 writeb(0x55, (void __iomem *) ioaddr->nsect_addr);
733 writeb(0xaa, (void __iomem *) ioaddr->lbal_addr);
735 writeb(0xaa, (void __iomem *) ioaddr->nsect_addr);
736 writeb(0x55, (void __iomem *) ioaddr->lbal_addr);
738 writeb(0x55, (void __iomem *) ioaddr->nsect_addr);
739 writeb(0xaa, (void __iomem *) ioaddr->lbal_addr);
741 nsect = readb((void __iomem *) ioaddr->nsect_addr);
742 lbal = readb((void __iomem *) ioaddr->lbal_addr);
744 if ((nsect == 0x55) && (lbal == 0xaa))
745 return 1; /* we found a device */
747 return 0; /* nothing found */
751 * ata_devchk - PATA device presence detection
752 * @ap: ATA channel to examine
753 * @device: Device to examine (starting at zero)
755 * Dispatch ATA device presence detection, depending
756 * on whether we are using PIO or MMIO to talk to the
757 * ATA shadow registers.
763 static unsigned int ata_devchk(struct ata_port *ap,
766 if (ap->flags & ATA_FLAG_MMIO)
767 return ata_mmio_devchk(ap, device);
768 return ata_pio_devchk(ap, device);
772 * ata_dev_classify - determine device type based on ATA-spec signature
773 * @tf: ATA taskfile register set for device to be identified
775 * Determine from taskfile register contents whether a device is
776 * ATA or ATAPI, as per "Signature and persistence" section
777 * of ATA/PI spec (volume 1, sect 5.14).
783 * Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, or %ATA_DEV_UNKNOWN
784 * the event of failure.
787 unsigned int ata_dev_classify(const struct ata_taskfile *tf)
789 /* Apple's open source Darwin code hints that some devices only
790 * put a proper signature into the LBA mid/high registers,
791 * So, we only check those. It's sufficient for uniqueness.
794 if (((tf->lbam == 0) && (tf->lbah == 0)) ||
795 ((tf->lbam == 0x3c) && (tf->lbah == 0xc3))) {
796 DPRINTK("found ATA device by sig\n");
800 if (((tf->lbam == 0x14) && (tf->lbah == 0xeb)) ||
801 ((tf->lbam == 0x69) && (tf->lbah == 0x96))) {
802 DPRINTK("found ATAPI device by sig\n");
803 return ATA_DEV_ATAPI;
806 DPRINTK("unknown device\n");
807 return ATA_DEV_UNKNOWN;
811 * ata_dev_try_classify - Parse returned ATA device signature
812 * @ap: ATA channel to examine
813 * @device: Device to examine (starting at zero)
815 * After an event -- SRST, E.D.D., or SATA COMRESET -- occurs,
816 * an ATA/ATAPI-defined set of values is placed in the ATA
817 * shadow registers, indicating the results of device detection
820 * Select the ATA device, and read the values from the ATA shadow
821 * registers. Then parse according to the Error register value,
822 * and the spec-defined values examined by ata_dev_classify().
828 static u8 ata_dev_try_classify(struct ata_port *ap, unsigned int device)
830 struct ata_device *dev = &ap->device[device];
831 struct ata_taskfile tf;
835 ap->ops->dev_select(ap, device);
837 memset(&tf, 0, sizeof(tf));
839 ap->ops->tf_read(ap, &tf);
842 dev->class = ATA_DEV_NONE;
844 /* see if device passed diags */
847 else if ((device == 0) && (err == 0x81))
852 /* determine if device if ATA or ATAPI */
853 class = ata_dev_classify(&tf);
854 if (class == ATA_DEV_UNKNOWN)
856 if ((class == ATA_DEV_ATA) && (ata_chk_status(ap) == 0))
865 * ata_dev_id_string - Convert IDENTIFY DEVICE page into string
866 * @id: IDENTIFY DEVICE results we will examine
867 * @s: string into which data is output
868 * @ofs: offset into identify device page
869 * @len: length of string to return. must be an even number.
871 * The strings in the IDENTIFY DEVICE page are broken up into
872 * 16-bit chunks. Run through the string, and output each
873 * 8-bit chunk linearly, regardless of platform.
879 void ata_dev_id_string(const u16 *id, unsigned char *s,
880 unsigned int ofs, unsigned int len)
900 * ata_noop_dev_select - Select device 0/1 on ATA bus
901 * @ap: ATA channel to manipulate
902 * @device: ATA device (numbered from zero) to select
904 * This function performs no actual function.
906 * May be used as the dev_select() entry in ata_port_operations.
911 void ata_noop_dev_select (struct ata_port *ap, unsigned int device)
917 * ata_std_dev_select - Select device 0/1 on ATA bus
918 * @ap: ATA channel to manipulate
919 * @device: ATA device (numbered from zero) to select
921 * Use the method defined in the ATA specification to
922 * make either device 0, or device 1, active on the
923 * ATA channel. Works with both PIO and MMIO.
925 * May be used as the dev_select() entry in ata_port_operations.
931 void ata_std_dev_select (struct ata_port *ap, unsigned int device)
936 tmp = ATA_DEVICE_OBS;
938 tmp = ATA_DEVICE_OBS | ATA_DEV1;
940 if (ap->flags & ATA_FLAG_MMIO) {
941 writeb(tmp, (void __iomem *) ap->ioaddr.device_addr);
943 outb(tmp, ap->ioaddr.device_addr);
945 ata_pause(ap); /* needed; also flushes, for mmio */
949 * ata_dev_select - Select device 0/1 on ATA bus
950 * @ap: ATA channel to manipulate
951 * @device: ATA device (numbered from zero) to select
952 * @wait: non-zero to wait for Status register BSY bit to clear
953 * @can_sleep: non-zero if context allows sleeping
955 * Use the method defined in the ATA specification to
956 * make either device 0, or device 1, active on the
959 * This is a high-level version of ata_std_dev_select(),
960 * which additionally provides the services of inserting
961 * the proper pauses and status polling, where needed.
967 void ata_dev_select(struct ata_port *ap, unsigned int device,
968 unsigned int wait, unsigned int can_sleep)
970 VPRINTK("ENTER, ata%u: device %u, wait %u\n",
971 ap->id, device, wait);
976 ap->ops->dev_select(ap, device);
979 if (can_sleep && ap->device[device].class == ATA_DEV_ATAPI)
986 * ata_dump_id - IDENTIFY DEVICE info debugging output
987 * @dev: Device whose IDENTIFY DEVICE page we will dump
989 * Dump selected 16-bit words from a detected device's
990 * IDENTIFY PAGE page.
996 static inline void ata_dump_id(const struct ata_device *dev)
998 DPRINTK("49==0x%04x "
1008 DPRINTK("80==0x%04x "
1018 DPRINTK("88==0x%04x "
1025 * Compute the PIO modes available for this device. This is not as
1026 * trivial as it seems if we must consider early devices correctly.
1028 * FIXME: pre IDE drive timing (do we care ?).
1031 static unsigned int ata_pio_modes(const struct ata_device *adev)
1035 /* Usual case. Word 53 indicates word 88 is valid */
1036 if (adev->id[ATA_ID_FIELD_VALID] & (1 << 2)) {
1037 modes = adev->id[ATA_ID_PIO_MODES] & 0x03;
1043 /* If word 88 isn't valid then Word 51 holds the PIO timing number
1044 for the maximum. Turn it into a mask and return it */
1045 modes = (2 << (adev->id[ATA_ID_OLD_PIO_MODES] & 0xFF)) - 1 ;
1049 struct ata_exec_internal_arg {
1050 unsigned int err_mask;
1051 struct ata_taskfile *tf;
1052 struct completion *waiting;
1055 int ata_qc_complete_internal(struct ata_queued_cmd *qc)
1057 struct ata_exec_internal_arg *arg = qc->private_data;
1058 struct completion *waiting = arg->waiting;
1060 if (!(qc->err_mask & ~AC_ERR_DEV))
1061 qc->ap->ops->tf_read(qc->ap, arg->tf);
1062 arg->err_mask = qc->err_mask;
1063 arg->waiting = NULL;
1070 * ata_exec_internal - execute libata internal command
1071 * @ap: Port to which the command is sent
1072 * @dev: Device to which the command is sent
1073 * @tf: Taskfile registers for the command and the result
1074 * @dma_dir: Data tranfer direction of the command
1075 * @buf: Data buffer of the command
1076 * @buflen: Length of data buffer
1078 * Executes libata internal command with timeout. @tf contains
1079 * command on entry and result on return. Timeout and error
1080 * conditions are reported via return value. No recovery action
1081 * is taken after a command times out. It's caller's duty to
1082 * clean up after timeout.
1085 * None. Should be called with kernel context, might sleep.
1089 ata_exec_internal(struct ata_port *ap, struct ata_device *dev,
1090 struct ata_taskfile *tf,
1091 int dma_dir, void *buf, unsigned int buflen)
1093 u8 command = tf->command;
1094 struct ata_queued_cmd *qc;
1095 DECLARE_COMPLETION(wait);
1096 unsigned long flags;
1097 struct ata_exec_internal_arg arg;
1099 spin_lock_irqsave(&ap->host_set->lock, flags);
1101 qc = ata_qc_new_init(ap, dev);
1105 qc->dma_dir = dma_dir;
1106 if (dma_dir != DMA_NONE) {
1107 ata_sg_init_one(qc, buf, buflen);
1108 qc->nsect = buflen / ATA_SECT_SIZE;
1111 arg.waiting = &wait;
1113 qc->private_data = &arg;
1114 qc->complete_fn = ata_qc_complete_internal;
1116 if (ata_qc_issue(qc))
1119 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1121 if (!wait_for_completion_timeout(&wait, ATA_TMOUT_INTERNAL)) {
1122 spin_lock_irqsave(&ap->host_set->lock, flags);
1124 /* We're racing with irq here. If we lose, the
1125 * following test prevents us from completing the qc
1126 * again. If completion irq occurs after here but
1127 * before the caller cleans up, it will result in a
1128 * spurious interrupt. We can live with that.
1131 qc->err_mask = AC_ERR_OTHER;
1132 ata_qc_complete(qc);
1133 printk(KERN_WARNING "ata%u: qc timeout (cmd 0x%x)\n",
1137 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1140 return arg.err_mask;
1144 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1145 return AC_ERR_OTHER;
1149 * ata_dev_identify - obtain IDENTIFY x DEVICE page
1150 * @ap: port on which device we wish to probe resides
1151 * @device: device bus address, starting at zero
1153 * Following bus reset, we issue the IDENTIFY [PACKET] DEVICE
1154 * command, and read back the 512-byte device information page.
1155 * The device information page is fed to us via the standard
1156 * PIO-IN protocol, but we hand-code it here. (TODO: investigate
1157 * using standard PIO-IN paths)
1159 * After reading the device information page, we use several
1160 * bits of information from it to initialize data structures
1161 * that will be used during the lifetime of the ata_device.
1162 * Other data from the info page is used to disqualify certain
1163 * older ATA devices we do not wish to support.
1166 * Inherited from caller. Some functions called by this function
1167 * obtain the host_set lock.
1170 static void ata_dev_identify(struct ata_port *ap, unsigned int device)
1172 struct ata_device *dev = &ap->device[device];
1173 unsigned int major_version;
1175 unsigned long xfer_modes;
1176 unsigned int using_edd;
1177 struct ata_taskfile tf;
1178 unsigned int err_mask;
1181 if (!ata_dev_present(dev)) {
1182 DPRINTK("ENTER/EXIT (host %u, dev %u) -- nodev\n",
1187 if (ap->flags & (ATA_FLAG_SRST | ATA_FLAG_SATA_RESET))
1192 DPRINTK("ENTER, host %u, dev %u\n", ap->id, device);
1194 assert (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ATAPI ||
1195 dev->class == ATA_DEV_NONE);
1197 ata_dev_select(ap, device, 1, 1); /* select device 0/1 */
1200 ata_tf_init(ap, &tf, device);
1202 if (dev->class == ATA_DEV_ATA) {
1203 tf.command = ATA_CMD_ID_ATA;
1204 DPRINTK("do ATA identify\n");
1206 tf.command = ATA_CMD_ID_ATAPI;
1207 DPRINTK("do ATAPI identify\n");
1210 tf.protocol = ATA_PROT_PIO;
1212 err_mask = ata_exec_internal(ap, dev, &tf, DMA_FROM_DEVICE,
1213 dev->id, sizeof(dev->id));
1216 if (err_mask & ~AC_ERR_DEV)
1220 * arg! EDD works for all test cases, but seems to return
1221 * the ATA signature for some ATAPI devices. Until the
1222 * reason for this is found and fixed, we fix up the mess
1223 * here. If IDENTIFY DEVICE returns command aborted
1224 * (as ATAPI devices do), then we issue an
1225 * IDENTIFY PACKET DEVICE.
1227 * ATA software reset (SRST, the default) does not appear
1228 * to have this problem.
1230 if ((using_edd) && (dev->class == ATA_DEV_ATA)) {
1231 u8 err = tf.feature;
1232 if (err & ATA_ABORTED) {
1233 dev->class = ATA_DEV_ATAPI;
1240 swap_buf_le16(dev->id, ATA_ID_WORDS);
1242 /* print device capabilities */
1243 printk(KERN_DEBUG "ata%u: dev %u cfg "
1244 "49:%04x 82:%04x 83:%04x 84:%04x 85:%04x 86:%04x 87:%04x 88:%04x\n",
1245 ap->id, device, dev->id[49],
1246 dev->id[82], dev->id[83], dev->id[84],
1247 dev->id[85], dev->id[86], dev->id[87],
1251 * common ATA, ATAPI feature tests
1254 /* we require DMA support (bits 8 of word 49) */
1255 if (!ata_id_has_dma(dev->id)) {
1256 printk(KERN_DEBUG "ata%u: no dma\n", ap->id);
1260 /* quick-n-dirty find max transfer mode; for printk only */
1261 xfer_modes = dev->id[ATA_ID_UDMA_MODES];
1263 xfer_modes = (dev->id[ATA_ID_MWDMA_MODES]) << ATA_SHIFT_MWDMA;
1265 xfer_modes = ata_pio_modes(dev);
1269 /* ATA-specific feature tests */
1270 if (dev->class == ATA_DEV_ATA) {
1271 if (!ata_id_is_ata(dev->id)) /* sanity check */
1274 /* get major version */
1275 tmp = dev->id[ATA_ID_MAJOR_VER];
1276 for (major_version = 14; major_version >= 1; major_version--)
1277 if (tmp & (1 << major_version))
1281 * The exact sequence expected by certain pre-ATA4 drives is:
1284 * INITIALIZE DEVICE PARAMETERS
1286 * Some drives were very specific about that exact sequence.
1288 if (major_version < 4 || (!ata_id_has_lba(dev->id))) {
1289 ata_dev_init_params(ap, dev);
1291 /* current CHS translation info (id[53-58]) might be
1292 * changed. reread the identify device info.
1294 ata_dev_reread_id(ap, dev);
1297 if (ata_id_has_lba(dev->id)) {
1298 dev->flags |= ATA_DFLAG_LBA;
1300 if (ata_id_has_lba48(dev->id)) {
1301 dev->flags |= ATA_DFLAG_LBA48;
1302 dev->n_sectors = ata_id_u64(dev->id, 100);
1304 dev->n_sectors = ata_id_u32(dev->id, 60);
1307 /* print device info to dmesg */
1308 printk(KERN_INFO "ata%u: dev %u ATA-%d, max %s, %Lu sectors:%s\n",
1311 ata_mode_string(xfer_modes),
1312 (unsigned long long)dev->n_sectors,
1313 dev->flags & ATA_DFLAG_LBA48 ? " LBA48" : " LBA");
1317 /* Default translation */
1318 dev->cylinders = dev->id[1];
1319 dev->heads = dev->id[3];
1320 dev->sectors = dev->id[6];
1321 dev->n_sectors = dev->cylinders * dev->heads * dev->sectors;
1323 if (ata_id_current_chs_valid(dev->id)) {
1324 /* Current CHS translation is valid. */
1325 dev->cylinders = dev->id[54];
1326 dev->heads = dev->id[55];
1327 dev->sectors = dev->id[56];
1329 dev->n_sectors = ata_id_u32(dev->id, 57);
1332 /* print device info to dmesg */
1333 printk(KERN_INFO "ata%u: dev %u ATA-%d, max %s, %Lu sectors: CHS %d/%d/%d\n",
1336 ata_mode_string(xfer_modes),
1337 (unsigned long long)dev->n_sectors,
1338 (int)dev->cylinders, (int)dev->heads, (int)dev->sectors);
1342 ap->host->max_cmd_len = 16;
1345 /* ATAPI-specific feature tests */
1346 else if (dev->class == ATA_DEV_ATAPI) {
1347 if (ata_id_is_ata(dev->id)) /* sanity check */
1350 rc = atapi_cdb_len(dev->id);
1351 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
1352 printk(KERN_WARNING "ata%u: unsupported CDB len\n", ap->id);
1355 ap->cdb_len = (unsigned int) rc;
1356 ap->host->max_cmd_len = (unsigned char) ap->cdb_len;
1358 /* print device info to dmesg */
1359 printk(KERN_INFO "ata%u: dev %u ATAPI, max %s\n",
1361 ata_mode_string(xfer_modes));
1364 DPRINTK("EXIT, drv_stat = 0x%x\n", ata_chk_status(ap));
1368 printk(KERN_WARNING "ata%u: dev %u not supported, ignoring\n",
1371 dev->class++; /* converts ATA_DEV_xxx into ATA_DEV_xxx_UNSUP */
1372 DPRINTK("EXIT, err\n");
1376 static inline u8 ata_dev_knobble(const struct ata_port *ap)
1378 return ((ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(ap->device->id)));
1382 * ata_dev_config - Run device specific handlers and check for
1383 * SATA->PATA bridges
1390 void ata_dev_config(struct ata_port *ap, unsigned int i)
1392 /* limit bridge transfers to udma5, 200 sectors */
1393 if (ata_dev_knobble(ap)) {
1394 printk(KERN_INFO "ata%u(%u): applying bridge limits\n",
1395 ap->id, ap->device->devno);
1396 ap->udma_mask &= ATA_UDMA5;
1397 ap->host->max_sectors = ATA_MAX_SECTORS;
1398 ap->host->hostt->max_sectors = ATA_MAX_SECTORS;
1399 ap->device->flags |= ATA_DFLAG_LOCK_SECTORS;
1402 if (ap->ops->dev_config)
1403 ap->ops->dev_config(ap, &ap->device[i]);
1407 * ata_bus_probe - Reset and probe ATA bus
1410 * Master ATA bus probing function. Initiates a hardware-dependent
1411 * bus reset, then attempts to identify any devices found on
1415 * PCI/etc. bus probe sem.
1418 * Zero on success, non-zero on error.
1421 static int ata_bus_probe(struct ata_port *ap)
1423 unsigned int i, found = 0;
1425 ap->ops->phy_reset(ap);
1426 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1429 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1430 ata_dev_identify(ap, i);
1431 if (ata_dev_present(&ap->device[i])) {
1433 ata_dev_config(ap,i);
1437 if ((!found) || (ap->flags & ATA_FLAG_PORT_DISABLED))
1438 goto err_out_disable;
1441 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1442 goto err_out_disable;
1447 ap->ops->port_disable(ap);
1453 * ata_port_probe - Mark port as enabled
1454 * @ap: Port for which we indicate enablement
1456 * Modify @ap data structure such that the system
1457 * thinks that the entire port is enabled.
1459 * LOCKING: host_set lock, or some other form of
1463 void ata_port_probe(struct ata_port *ap)
1465 ap->flags &= ~ATA_FLAG_PORT_DISABLED;
1469 * __sata_phy_reset - Wake/reset a low-level SATA PHY
1470 * @ap: SATA port associated with target SATA PHY.
1472 * This function issues commands to standard SATA Sxxx
1473 * PHY registers, to wake up the phy (and device), and
1474 * clear any reset condition.
1477 * PCI/etc. bus probe sem.
1480 void __sata_phy_reset(struct ata_port *ap)
1483 unsigned long timeout = jiffies + (HZ * 5);
1485 if (ap->flags & ATA_FLAG_SATA_RESET) {
1486 /* issue phy wake/reset */
1487 scr_write_flush(ap, SCR_CONTROL, 0x301);
1488 /* Couldn't find anything in SATA I/II specs, but
1489 * AHCI-1.1 10.4.2 says at least 1 ms. */
1492 scr_write_flush(ap, SCR_CONTROL, 0x300); /* phy wake/clear reset */
1494 /* wait for phy to become ready, if necessary */
1497 sstatus = scr_read(ap, SCR_STATUS);
1498 if ((sstatus & 0xf) != 1)
1500 } while (time_before(jiffies, timeout));
1502 /* TODO: phy layer with polling, timeouts, etc. */
1503 sstatus = scr_read(ap, SCR_STATUS);
1504 if (sata_dev_present(ap)) {
1508 tmp = (sstatus >> 4) & 0xf;
1511 else if (tmp & (1 << 1))
1514 speed = "<unknown>";
1515 printk(KERN_INFO "ata%u: SATA link up %s Gbps (SStatus %X)\n",
1516 ap->id, speed, sstatus);
1519 printk(KERN_INFO "ata%u: SATA link down (SStatus %X)\n",
1521 ata_port_disable(ap);
1524 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1527 if (ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT)) {
1528 ata_port_disable(ap);
1532 ap->cbl = ATA_CBL_SATA;
1536 * sata_phy_reset - Reset SATA bus.
1537 * @ap: SATA port associated with target SATA PHY.
1539 * This function resets the SATA bus, and then probes
1540 * the bus for devices.
1543 * PCI/etc. bus probe sem.
1546 void sata_phy_reset(struct ata_port *ap)
1548 __sata_phy_reset(ap);
1549 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1555 * ata_port_disable - Disable port.
1556 * @ap: Port to be disabled.
1558 * Modify @ap data structure such that the system
1559 * thinks that the entire port is disabled, and should
1560 * never attempt to probe or communicate with devices
1563 * LOCKING: host_set lock, or some other form of
1567 void ata_port_disable(struct ata_port *ap)
1569 ap->device[0].class = ATA_DEV_NONE;
1570 ap->device[1].class = ATA_DEV_NONE;
1571 ap->flags |= ATA_FLAG_PORT_DISABLED;
1575 * This mode timing computation functionality is ported over from
1576 * drivers/ide/ide-timing.h and was originally written by Vojtech Pavlik
1579 * PIO 0-5, MWDMA 0-2 and UDMA 0-6 timings (in nanoseconds).
1580 * These were taken from ATA/ATAPI-6 standard, rev 0a, except
1581 * for PIO 5, which is a nonstandard extension and UDMA6, which
1582 * is currently supported only by Maxtor drives.
1585 static const struct ata_timing ata_timing[] = {
1587 { XFER_UDMA_6, 0, 0, 0, 0, 0, 0, 0, 15 },
1588 { XFER_UDMA_5, 0, 0, 0, 0, 0, 0, 0, 20 },
1589 { XFER_UDMA_4, 0, 0, 0, 0, 0, 0, 0, 30 },
1590 { XFER_UDMA_3, 0, 0, 0, 0, 0, 0, 0, 45 },
1592 { XFER_UDMA_2, 0, 0, 0, 0, 0, 0, 0, 60 },
1593 { XFER_UDMA_1, 0, 0, 0, 0, 0, 0, 0, 80 },
1594 { XFER_UDMA_0, 0, 0, 0, 0, 0, 0, 0, 120 },
1596 /* { XFER_UDMA_SLOW, 0, 0, 0, 0, 0, 0, 0, 150 }, */
1598 { XFER_MW_DMA_2, 25, 0, 0, 0, 70, 25, 120, 0 },
1599 { XFER_MW_DMA_1, 45, 0, 0, 0, 80, 50, 150, 0 },
1600 { XFER_MW_DMA_0, 60, 0, 0, 0, 215, 215, 480, 0 },
1602 { XFER_SW_DMA_2, 60, 0, 0, 0, 120, 120, 240, 0 },
1603 { XFER_SW_DMA_1, 90, 0, 0, 0, 240, 240, 480, 0 },
1604 { XFER_SW_DMA_0, 120, 0, 0, 0, 480, 480, 960, 0 },
1606 /* { XFER_PIO_5, 20, 50, 30, 100, 50, 30, 100, 0 }, */
1607 { XFER_PIO_4, 25, 70, 25, 120, 70, 25, 120, 0 },
1608 { XFER_PIO_3, 30, 80, 70, 180, 80, 70, 180, 0 },
1610 { XFER_PIO_2, 30, 290, 40, 330, 100, 90, 240, 0 },
1611 { XFER_PIO_1, 50, 290, 93, 383, 125, 100, 383, 0 },
1612 { XFER_PIO_0, 70, 290, 240, 600, 165, 150, 600, 0 },
1614 /* { XFER_PIO_SLOW, 120, 290, 240, 960, 290, 240, 960, 0 }, */
1619 #define ENOUGH(v,unit) (((v)-1)/(unit)+1)
1620 #define EZ(v,unit) ((v)?ENOUGH(v,unit):0)
1622 static void ata_timing_quantize(const struct ata_timing *t, struct ata_timing *q, int T, int UT)
1624 q->setup = EZ(t->setup * 1000, T);
1625 q->act8b = EZ(t->act8b * 1000, T);
1626 q->rec8b = EZ(t->rec8b * 1000, T);
1627 q->cyc8b = EZ(t->cyc8b * 1000, T);
1628 q->active = EZ(t->active * 1000, T);
1629 q->recover = EZ(t->recover * 1000, T);
1630 q->cycle = EZ(t->cycle * 1000, T);
1631 q->udma = EZ(t->udma * 1000, UT);
1634 void ata_timing_merge(const struct ata_timing *a, const struct ata_timing *b,
1635 struct ata_timing *m, unsigned int what)
1637 if (what & ATA_TIMING_SETUP ) m->setup = max(a->setup, b->setup);
1638 if (what & ATA_TIMING_ACT8B ) m->act8b = max(a->act8b, b->act8b);
1639 if (what & ATA_TIMING_REC8B ) m->rec8b = max(a->rec8b, b->rec8b);
1640 if (what & ATA_TIMING_CYC8B ) m->cyc8b = max(a->cyc8b, b->cyc8b);
1641 if (what & ATA_TIMING_ACTIVE ) m->active = max(a->active, b->active);
1642 if (what & ATA_TIMING_RECOVER) m->recover = max(a->recover, b->recover);
1643 if (what & ATA_TIMING_CYCLE ) m->cycle = max(a->cycle, b->cycle);
1644 if (what & ATA_TIMING_UDMA ) m->udma = max(a->udma, b->udma);
1647 static const struct ata_timing* ata_timing_find_mode(unsigned short speed)
1649 const struct ata_timing *t;
1651 for (t = ata_timing; t->mode != speed; t++)
1652 if (t->mode == 0xFF)
1657 int ata_timing_compute(struct ata_device *adev, unsigned short speed,
1658 struct ata_timing *t, int T, int UT)
1660 const struct ata_timing *s;
1661 struct ata_timing p;
1667 if (!(s = ata_timing_find_mode(speed)))
1670 memcpy(t, s, sizeof(*s));
1673 * If the drive is an EIDE drive, it can tell us it needs extended
1674 * PIO/MW_DMA cycle timing.
1677 if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE drive */
1678 memset(&p, 0, sizeof(p));
1679 if(speed >= XFER_PIO_0 && speed <= XFER_SW_DMA_0) {
1680 if (speed <= XFER_PIO_2) p.cycle = p.cyc8b = adev->id[ATA_ID_EIDE_PIO];
1681 else p.cycle = p.cyc8b = adev->id[ATA_ID_EIDE_PIO_IORDY];
1682 } else if(speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2) {
1683 p.cycle = adev->id[ATA_ID_EIDE_DMA_MIN];
1685 ata_timing_merge(&p, t, t, ATA_TIMING_CYCLE | ATA_TIMING_CYC8B);
1689 * Convert the timing to bus clock counts.
1692 ata_timing_quantize(t, t, T, UT);
1695 * Even in DMA/UDMA modes we still use PIO access for IDENTIFY, S.M.A.R.T
1696 * and some other commands. We have to ensure that the DMA cycle timing is
1697 * slower/equal than the fastest PIO timing.
1700 if (speed > XFER_PIO_4) {
1701 ata_timing_compute(adev, adev->pio_mode, &p, T, UT);
1702 ata_timing_merge(&p, t, t, ATA_TIMING_ALL);
1706 * Lenghten active & recovery time so that cycle time is correct.
1709 if (t->act8b + t->rec8b < t->cyc8b) {
1710 t->act8b += (t->cyc8b - (t->act8b + t->rec8b)) / 2;
1711 t->rec8b = t->cyc8b - t->act8b;
1714 if (t->active + t->recover < t->cycle) {
1715 t->active += (t->cycle - (t->active + t->recover)) / 2;
1716 t->recover = t->cycle - t->active;
1722 static const struct {
1725 } xfer_mode_classes[] = {
1726 { ATA_SHIFT_UDMA, XFER_UDMA_0 },
1727 { ATA_SHIFT_MWDMA, XFER_MW_DMA_0 },
1728 { ATA_SHIFT_PIO, XFER_PIO_0 },
1731 static inline u8 base_from_shift(unsigned int shift)
1735 for (i = 0; i < ARRAY_SIZE(xfer_mode_classes); i++)
1736 if (xfer_mode_classes[i].shift == shift)
1737 return xfer_mode_classes[i].base;
1742 static void ata_dev_set_mode(struct ata_port *ap, struct ata_device *dev)
1747 if (!ata_dev_present(dev) || (ap->flags & ATA_FLAG_PORT_DISABLED))
1750 if (dev->xfer_shift == ATA_SHIFT_PIO)
1751 dev->flags |= ATA_DFLAG_PIO;
1753 ata_dev_set_xfermode(ap, dev);
1755 base = base_from_shift(dev->xfer_shift);
1756 ofs = dev->xfer_mode - base;
1757 idx = ofs + dev->xfer_shift;
1758 WARN_ON(idx >= ARRAY_SIZE(xfer_mode_str));
1760 DPRINTK("idx=%d xfer_shift=%u, xfer_mode=0x%x, base=0x%x, offset=%d\n",
1761 idx, dev->xfer_shift, (int)dev->xfer_mode, (int)base, ofs);
1763 printk(KERN_INFO "ata%u: dev %u configured for %s\n",
1764 ap->id, dev->devno, xfer_mode_str[idx]);
1767 static int ata_host_set_pio(struct ata_port *ap)
1773 mask = ata_get_mode_mask(ap, ATA_SHIFT_PIO);
1776 printk(KERN_WARNING "ata%u: no PIO support\n", ap->id);
1780 base = base_from_shift(ATA_SHIFT_PIO);
1781 xfer_mode = base + x;
1783 DPRINTK("base 0x%x xfer_mode 0x%x mask 0x%x x %d\n",
1784 (int)base, (int)xfer_mode, mask, x);
1786 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1787 struct ata_device *dev = &ap->device[i];
1788 if (ata_dev_present(dev)) {
1789 dev->pio_mode = xfer_mode;
1790 dev->xfer_mode = xfer_mode;
1791 dev->xfer_shift = ATA_SHIFT_PIO;
1792 if (ap->ops->set_piomode)
1793 ap->ops->set_piomode(ap, dev);
1800 static void ata_host_set_dma(struct ata_port *ap, u8 xfer_mode,
1801 unsigned int xfer_shift)
1805 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1806 struct ata_device *dev = &ap->device[i];
1807 if (ata_dev_present(dev)) {
1808 dev->dma_mode = xfer_mode;
1809 dev->xfer_mode = xfer_mode;
1810 dev->xfer_shift = xfer_shift;
1811 if (ap->ops->set_dmamode)
1812 ap->ops->set_dmamode(ap, dev);
1818 * ata_set_mode - Program timings and issue SET FEATURES - XFER
1819 * @ap: port on which timings will be programmed
1821 * Set ATA device disk transfer mode (PIO3, UDMA6, etc.).
1824 * PCI/etc. bus probe sem.
1827 static void ata_set_mode(struct ata_port *ap)
1829 unsigned int xfer_shift;
1833 /* step 1: always set host PIO timings */
1834 rc = ata_host_set_pio(ap);
1838 /* step 2: choose the best data xfer mode */
1839 xfer_mode = xfer_shift = 0;
1840 rc = ata_choose_xfer_mode(ap, &xfer_mode, &xfer_shift);
1844 /* step 3: if that xfer mode isn't PIO, set host DMA timings */
1845 if (xfer_shift != ATA_SHIFT_PIO)
1846 ata_host_set_dma(ap, xfer_mode, xfer_shift);
1848 /* step 4: update devices' xfer mode */
1849 ata_dev_set_mode(ap, &ap->device[0]);
1850 ata_dev_set_mode(ap, &ap->device[1]);
1852 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1855 if (ap->ops->post_set_mode)
1856 ap->ops->post_set_mode(ap);
1861 ata_port_disable(ap);
1865 * ata_busy_sleep - sleep until BSY clears, or timeout
1866 * @ap: port containing status register to be polled
1867 * @tmout_pat: impatience timeout
1868 * @tmout: overall timeout
1870 * Sleep until ATA Status register bit BSY clears,
1871 * or a timeout occurs.
1877 static unsigned int ata_busy_sleep (struct ata_port *ap,
1878 unsigned long tmout_pat,
1879 unsigned long tmout)
1881 unsigned long timer_start, timeout;
1884 status = ata_busy_wait(ap, ATA_BUSY, 300);
1885 timer_start = jiffies;
1886 timeout = timer_start + tmout_pat;
1887 while ((status & ATA_BUSY) && (time_before(jiffies, timeout))) {
1889 status = ata_busy_wait(ap, ATA_BUSY, 3);
1892 if (status & ATA_BUSY)
1893 printk(KERN_WARNING "ata%u is slow to respond, "
1894 "please be patient\n", ap->id);
1896 timeout = timer_start + tmout;
1897 while ((status & ATA_BUSY) && (time_before(jiffies, timeout))) {
1899 status = ata_chk_status(ap);
1902 if (status & ATA_BUSY) {
1903 printk(KERN_ERR "ata%u failed to respond (%lu secs)\n",
1904 ap->id, tmout / HZ);
1911 static void ata_bus_post_reset(struct ata_port *ap, unsigned int devmask)
1913 struct ata_ioports *ioaddr = &ap->ioaddr;
1914 unsigned int dev0 = devmask & (1 << 0);
1915 unsigned int dev1 = devmask & (1 << 1);
1916 unsigned long timeout;
1918 /* if device 0 was found in ata_devchk, wait for its
1922 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1924 /* if device 1 was found in ata_devchk, wait for
1925 * register access, then wait for BSY to clear
1927 timeout = jiffies + ATA_TMOUT_BOOT;
1931 ap->ops->dev_select(ap, 1);
1932 if (ap->flags & ATA_FLAG_MMIO) {
1933 nsect = readb((void __iomem *) ioaddr->nsect_addr);
1934 lbal = readb((void __iomem *) ioaddr->lbal_addr);
1936 nsect = inb(ioaddr->nsect_addr);
1937 lbal = inb(ioaddr->lbal_addr);
1939 if ((nsect == 1) && (lbal == 1))
1941 if (time_after(jiffies, timeout)) {
1945 msleep(50); /* give drive a breather */
1948 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1950 /* is all this really necessary? */
1951 ap->ops->dev_select(ap, 0);
1953 ap->ops->dev_select(ap, 1);
1955 ap->ops->dev_select(ap, 0);
1959 * ata_bus_edd - Issue EXECUTE DEVICE DIAGNOSTIC command.
1960 * @ap: Port to reset and probe
1962 * Use the EXECUTE DEVICE DIAGNOSTIC command to reset and
1963 * probe the bus. Not often used these days.
1966 * PCI/etc. bus probe sem.
1967 * Obtains host_set lock.
1971 static unsigned int ata_bus_edd(struct ata_port *ap)
1973 struct ata_taskfile tf;
1974 unsigned long flags;
1976 /* set up execute-device-diag (bus reset) taskfile */
1977 /* also, take interrupts to a known state (disabled) */
1978 DPRINTK("execute-device-diag\n");
1979 ata_tf_init(ap, &tf, 0);
1981 tf.command = ATA_CMD_EDD;
1982 tf.protocol = ATA_PROT_NODATA;
1985 spin_lock_irqsave(&ap->host_set->lock, flags);
1986 ata_tf_to_host(ap, &tf);
1987 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1989 /* spec says at least 2ms. but who knows with those
1990 * crazy ATAPI devices...
1994 return ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1997 static unsigned int ata_bus_softreset(struct ata_port *ap,
1998 unsigned int devmask)
2000 struct ata_ioports *ioaddr = &ap->ioaddr;
2002 DPRINTK("ata%u: bus reset via SRST\n", ap->id);
2004 /* software reset. causes dev0 to be selected */
2005 if (ap->flags & ATA_FLAG_MMIO) {
2006 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2007 udelay(20); /* FIXME: flush */
2008 writeb(ap->ctl | ATA_SRST, (void __iomem *) ioaddr->ctl_addr);
2009 udelay(20); /* FIXME: flush */
2010 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2012 outb(ap->ctl, ioaddr->ctl_addr);
2014 outb(ap->ctl | ATA_SRST, ioaddr->ctl_addr);
2016 outb(ap->ctl, ioaddr->ctl_addr);
2019 /* spec mandates ">= 2ms" before checking status.
2020 * We wait 150ms, because that was the magic delay used for
2021 * ATAPI devices in Hale Landis's ATADRVR, for the period of time
2022 * between when the ATA command register is written, and then
2023 * status is checked. Because waiting for "a while" before
2024 * checking status is fine, post SRST, we perform this magic
2025 * delay here as well.
2029 ata_bus_post_reset(ap, devmask);
2035 * ata_bus_reset - reset host port and associated ATA channel
2036 * @ap: port to reset
2038 * This is typically the first time we actually start issuing
2039 * commands to the ATA channel. We wait for BSY to clear, then
2040 * issue EXECUTE DEVICE DIAGNOSTIC command, polling for its
2041 * result. Determine what devices, if any, are on the channel
2042 * by looking at the device 0/1 error register. Look at the signature
2043 * stored in each device's taskfile registers, to determine if
2044 * the device is ATA or ATAPI.
2047 * PCI/etc. bus probe sem.
2048 * Obtains host_set lock.
2051 * Sets ATA_FLAG_PORT_DISABLED if bus reset fails.
2054 void ata_bus_reset(struct ata_port *ap)
2056 struct ata_ioports *ioaddr = &ap->ioaddr;
2057 unsigned int slave_possible = ap->flags & ATA_FLAG_SLAVE_POSS;
2059 unsigned int dev0, dev1 = 0, rc = 0, devmask = 0;
2061 DPRINTK("ENTER, host %u, port %u\n", ap->id, ap->port_no);
2063 /* determine if device 0/1 are present */
2064 if (ap->flags & ATA_FLAG_SATA_RESET)
2067 dev0 = ata_devchk(ap, 0);
2069 dev1 = ata_devchk(ap, 1);
2073 devmask |= (1 << 0);
2075 devmask |= (1 << 1);
2077 /* select device 0 again */
2078 ap->ops->dev_select(ap, 0);
2080 /* issue bus reset */
2081 if (ap->flags & ATA_FLAG_SRST)
2082 rc = ata_bus_softreset(ap, devmask);
2083 else if ((ap->flags & ATA_FLAG_SATA_RESET) == 0) {
2084 /* set up device control */
2085 if (ap->flags & ATA_FLAG_MMIO)
2086 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2088 outb(ap->ctl, ioaddr->ctl_addr);
2089 rc = ata_bus_edd(ap);
2096 * determine by signature whether we have ATA or ATAPI devices
2098 err = ata_dev_try_classify(ap, 0);
2099 if ((slave_possible) && (err != 0x81))
2100 ata_dev_try_classify(ap, 1);
2102 /* re-enable interrupts */
2103 if (ap->ioaddr.ctl_addr) /* FIXME: hack. create a hook instead */
2106 /* is double-select really necessary? */
2107 if (ap->device[1].class != ATA_DEV_NONE)
2108 ap->ops->dev_select(ap, 1);
2109 if (ap->device[0].class != ATA_DEV_NONE)
2110 ap->ops->dev_select(ap, 0);
2112 /* if no devices were detected, disable this port */
2113 if ((ap->device[0].class == ATA_DEV_NONE) &&
2114 (ap->device[1].class == ATA_DEV_NONE))
2117 if (ap->flags & (ATA_FLAG_SATA_RESET | ATA_FLAG_SRST)) {
2118 /* set up device control for ATA_FLAG_SATA_RESET */
2119 if (ap->flags & ATA_FLAG_MMIO)
2120 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2122 outb(ap->ctl, ioaddr->ctl_addr);
2129 printk(KERN_ERR "ata%u: disabling port\n", ap->id);
2130 ap->ops->port_disable(ap);
2135 static void ata_pr_blacklisted(const struct ata_port *ap,
2136 const struct ata_device *dev)
2138 printk(KERN_WARNING "ata%u: dev %u is on DMA blacklist, disabling DMA\n",
2139 ap->id, dev->devno);
2142 static const char * const ata_dma_blacklist [] = {
2161 "Toshiba CD-ROM XM-6202B",
2162 "TOSHIBA CD-ROM XM-1702BC",
2164 "E-IDE CD-ROM CR-840",
2167 "SAMSUNG CD-ROM SC-148C",
2168 "SAMSUNG CD-ROM SC",
2170 "ATAPI CD-ROM DRIVE 40X MAXIMUM",
2174 static int ata_dma_blacklisted(const struct ata_device *dev)
2176 unsigned char model_num[40];
2181 ata_dev_id_string(dev->id, model_num, ATA_ID_PROD_OFS,
2184 len = strnlen(s, sizeof(model_num));
2186 /* ATAPI specifies that empty space is blank-filled; remove blanks */
2187 while ((len > 0) && (s[len - 1] == ' ')) {
2192 for (i = 0; i < ARRAY_SIZE(ata_dma_blacklist); i++)
2193 if (!strncmp(ata_dma_blacklist[i], s, len))
2199 static unsigned int ata_get_mode_mask(const struct ata_port *ap, int shift)
2201 const struct ata_device *master, *slave;
2204 master = &ap->device[0];
2205 slave = &ap->device[1];
2207 assert (ata_dev_present(master) || ata_dev_present(slave));
2209 if (shift == ATA_SHIFT_UDMA) {
2210 mask = ap->udma_mask;
2211 if (ata_dev_present(master)) {
2212 mask &= (master->id[ATA_ID_UDMA_MODES] & 0xff);
2213 if (ata_dma_blacklisted(master)) {
2215 ata_pr_blacklisted(ap, master);
2218 if (ata_dev_present(slave)) {
2219 mask &= (slave->id[ATA_ID_UDMA_MODES] & 0xff);
2220 if (ata_dma_blacklisted(slave)) {
2222 ata_pr_blacklisted(ap, slave);
2226 else if (shift == ATA_SHIFT_MWDMA) {
2227 mask = ap->mwdma_mask;
2228 if (ata_dev_present(master)) {
2229 mask &= (master->id[ATA_ID_MWDMA_MODES] & 0x07);
2230 if (ata_dma_blacklisted(master)) {
2232 ata_pr_blacklisted(ap, master);
2235 if (ata_dev_present(slave)) {
2236 mask &= (slave->id[ATA_ID_MWDMA_MODES] & 0x07);
2237 if (ata_dma_blacklisted(slave)) {
2239 ata_pr_blacklisted(ap, slave);
2243 else if (shift == ATA_SHIFT_PIO) {
2244 mask = ap->pio_mask;
2245 if (ata_dev_present(master)) {
2246 /* spec doesn't return explicit support for
2247 * PIO0-2, so we fake it
2249 u16 tmp_mode = master->id[ATA_ID_PIO_MODES] & 0x03;
2254 if (ata_dev_present(slave)) {
2255 /* spec doesn't return explicit support for
2256 * PIO0-2, so we fake it
2258 u16 tmp_mode = slave->id[ATA_ID_PIO_MODES] & 0x03;
2265 mask = 0xffffffff; /* shut up compiler warning */
2272 /* find greatest bit */
2273 static int fgb(u32 bitmap)
2278 for (i = 0; i < 32; i++)
2279 if (bitmap & (1 << i))
2286 * ata_choose_xfer_mode - attempt to find best transfer mode
2287 * @ap: Port for which an xfer mode will be selected
2288 * @xfer_mode_out: (output) SET FEATURES - XFER MODE code
2289 * @xfer_shift_out: (output) bit shift that selects this mode
2291 * Based on host and device capabilities, determine the
2292 * maximum transfer mode that is amenable to all.
2295 * PCI/etc. bus probe sem.
2298 * Zero on success, negative on error.
2301 static int ata_choose_xfer_mode(const struct ata_port *ap,
2303 unsigned int *xfer_shift_out)
2305 unsigned int mask, shift;
2308 for (i = 0; i < ARRAY_SIZE(xfer_mode_classes); i++) {
2309 shift = xfer_mode_classes[i].shift;
2310 mask = ata_get_mode_mask(ap, shift);
2314 *xfer_mode_out = xfer_mode_classes[i].base + x;
2315 *xfer_shift_out = shift;
2324 * ata_dev_set_xfermode - Issue SET FEATURES - XFER MODE command
2325 * @ap: Port associated with device @dev
2326 * @dev: Device to which command will be sent
2328 * Issue SET FEATURES - XFER MODE command to device @dev
2332 * PCI/etc. bus probe sem.
2335 static void ata_dev_set_xfermode(struct ata_port *ap, struct ata_device *dev)
2337 struct ata_taskfile tf;
2339 /* set up set-features taskfile */
2340 DPRINTK("set features - xfer mode\n");
2342 ata_tf_init(ap, &tf, dev->devno);
2343 tf.command = ATA_CMD_SET_FEATURES;
2344 tf.feature = SETFEATURES_XFER;
2345 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2346 tf.protocol = ATA_PROT_NODATA;
2347 tf.nsect = dev->xfer_mode;
2349 if (ata_exec_internal(ap, dev, &tf, DMA_NONE, NULL, 0)) {
2350 printk(KERN_ERR "ata%u: failed to set xfermode, disabled\n",
2352 ata_port_disable(ap);
2359 * ata_dev_reread_id - Reread the device identify device info
2360 * @ap: port where the device is
2361 * @dev: device to reread the identify device info
2366 static void ata_dev_reread_id(struct ata_port *ap, struct ata_device *dev)
2368 struct ata_taskfile tf;
2370 ata_tf_init(ap, &tf, dev->devno);
2372 if (dev->class == ATA_DEV_ATA) {
2373 tf.command = ATA_CMD_ID_ATA;
2374 DPRINTK("do ATA identify\n");
2376 tf.command = ATA_CMD_ID_ATAPI;
2377 DPRINTK("do ATAPI identify\n");
2380 tf.flags |= ATA_TFLAG_DEVICE;
2381 tf.protocol = ATA_PROT_PIO;
2383 if (ata_exec_internal(ap, dev, &tf, DMA_FROM_DEVICE,
2384 dev->id, sizeof(dev->id)))
2387 swap_buf_le16(dev->id, ATA_ID_WORDS);
2395 printk(KERN_ERR "ata%u: failed to reread ID, disabled\n", ap->id);
2396 ata_port_disable(ap);
2400 * ata_dev_init_params - Issue INIT DEV PARAMS command
2401 * @ap: Port associated with device @dev
2402 * @dev: Device to which command will be sent
2407 static void ata_dev_init_params(struct ata_port *ap, struct ata_device *dev)
2409 struct ata_taskfile tf;
2410 u16 sectors = dev->id[6];
2411 u16 heads = dev->id[3];
2413 /* Number of sectors per track 1-255. Number of heads 1-16 */
2414 if (sectors < 1 || sectors > 255 || heads < 1 || heads > 16)
2417 /* set up init dev params taskfile */
2418 DPRINTK("init dev params \n");
2420 ata_tf_init(ap, &tf, dev->devno);
2421 tf.command = ATA_CMD_INIT_DEV_PARAMS;
2422 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2423 tf.protocol = ATA_PROT_NODATA;
2425 tf.device |= (heads - 1) & 0x0f; /* max head = num. of heads - 1 */
2427 if (ata_exec_internal(ap, dev, &tf, DMA_NONE, NULL, 0)) {
2428 printk(KERN_ERR "ata%u: failed to init parameters, disabled\n",
2430 ata_port_disable(ap);
2437 * ata_sg_clean - Unmap DMA memory associated with command
2438 * @qc: Command containing DMA memory to be released
2440 * Unmap all mapped DMA memory associated with this command.
2443 * spin_lock_irqsave(host_set lock)
2446 static void ata_sg_clean(struct ata_queued_cmd *qc)
2448 struct ata_port *ap = qc->ap;
2449 struct scatterlist *sg = qc->__sg;
2450 int dir = qc->dma_dir;
2451 void *pad_buf = NULL;
2453 assert(qc->flags & ATA_QCFLAG_DMAMAP);
2456 if (qc->flags & ATA_QCFLAG_SINGLE)
2457 assert(qc->n_elem == 1);
2459 VPRINTK("unmapping %u sg elements\n", qc->n_elem);
2461 /* if we padded the buffer out to 32-bit bound, and data
2462 * xfer direction is from-device, we must copy from the
2463 * pad buffer back into the supplied buffer
2465 if (qc->pad_len && !(qc->tf.flags & ATA_TFLAG_WRITE))
2466 pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
2468 if (qc->flags & ATA_QCFLAG_SG) {
2470 dma_unmap_sg(ap->host_set->dev, sg, qc->n_elem, dir);
2471 /* restore last sg */
2472 sg[qc->orig_n_elem - 1].length += qc->pad_len;
2474 struct scatterlist *psg = &qc->pad_sgent;
2475 void *addr = kmap_atomic(psg->page, KM_IRQ0);
2476 memcpy(addr + psg->offset, pad_buf, qc->pad_len);
2477 kunmap_atomic(addr, KM_IRQ0);
2480 if (sg_dma_len(&sg[0]) > 0)
2481 dma_unmap_single(ap->host_set->dev,
2482 sg_dma_address(&sg[0]), sg_dma_len(&sg[0]),
2485 sg->length += qc->pad_len;
2487 memcpy(qc->buf_virt + sg->length - qc->pad_len,
2488 pad_buf, qc->pad_len);
2491 qc->flags &= ~ATA_QCFLAG_DMAMAP;
2496 * ata_fill_sg - Fill PCI IDE PRD table
2497 * @qc: Metadata associated with taskfile to be transferred
2499 * Fill PCI IDE PRD (scatter-gather) table with segments
2500 * associated with the current disk command.
2503 * spin_lock_irqsave(host_set lock)
2506 static void ata_fill_sg(struct ata_queued_cmd *qc)
2508 struct ata_port *ap = qc->ap;
2509 struct scatterlist *sg;
2512 assert(qc->__sg != NULL);
2513 assert(qc->n_elem > 0);
2516 ata_for_each_sg(sg, qc) {
2520 /* determine if physical DMA addr spans 64K boundary.
2521 * Note h/w doesn't support 64-bit, so we unconditionally
2522 * truncate dma_addr_t to u32.
2524 addr = (u32) sg_dma_address(sg);
2525 sg_len = sg_dma_len(sg);
2528 offset = addr & 0xffff;
2530 if ((offset + sg_len) > 0x10000)
2531 len = 0x10000 - offset;
2533 ap->prd[idx].addr = cpu_to_le32(addr);
2534 ap->prd[idx].flags_len = cpu_to_le32(len & 0xffff);
2535 VPRINTK("PRD[%u] = (0x%X, 0x%X)\n", idx, addr, len);
2544 ap->prd[idx - 1].flags_len |= cpu_to_le32(ATA_PRD_EOT);
2547 * ata_check_atapi_dma - Check whether ATAPI DMA can be supported
2548 * @qc: Metadata associated with taskfile to check
2550 * Allow low-level driver to filter ATA PACKET commands, returning
2551 * a status indicating whether or not it is OK to use DMA for the
2552 * supplied PACKET command.
2555 * spin_lock_irqsave(host_set lock)
2557 * RETURNS: 0 when ATAPI DMA can be used
2560 int ata_check_atapi_dma(struct ata_queued_cmd *qc)
2562 struct ata_port *ap = qc->ap;
2563 int rc = 0; /* Assume ATAPI DMA is OK by default */
2565 if (ap->ops->check_atapi_dma)
2566 rc = ap->ops->check_atapi_dma(qc);
2571 * ata_qc_prep - Prepare taskfile for submission
2572 * @qc: Metadata associated with taskfile to be prepared
2574 * Prepare ATA taskfile for submission.
2577 * spin_lock_irqsave(host_set lock)
2579 void ata_qc_prep(struct ata_queued_cmd *qc)
2581 if (!(qc->flags & ATA_QCFLAG_DMAMAP))
2588 * ata_sg_init_one - Associate command with memory buffer
2589 * @qc: Command to be associated
2590 * @buf: Memory buffer
2591 * @buflen: Length of memory buffer, in bytes.
2593 * Initialize the data-related elements of queued_cmd @qc
2594 * to point to a single memory buffer, @buf of byte length @buflen.
2597 * spin_lock_irqsave(host_set lock)
2600 void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, unsigned int buflen)
2602 struct scatterlist *sg;
2604 qc->flags |= ATA_QCFLAG_SINGLE;
2606 memset(&qc->sgent, 0, sizeof(qc->sgent));
2607 qc->__sg = &qc->sgent;
2609 qc->orig_n_elem = 1;
2613 sg_init_one(sg, buf, buflen);
2617 * ata_sg_init - Associate command with scatter-gather table.
2618 * @qc: Command to be associated
2619 * @sg: Scatter-gather table.
2620 * @n_elem: Number of elements in s/g table.
2622 * Initialize the data-related elements of queued_cmd @qc
2623 * to point to a scatter-gather table @sg, containing @n_elem
2627 * spin_lock_irqsave(host_set lock)
2630 void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
2631 unsigned int n_elem)
2633 qc->flags |= ATA_QCFLAG_SG;
2635 qc->n_elem = n_elem;
2636 qc->orig_n_elem = n_elem;
2640 * ata_sg_setup_one - DMA-map the memory buffer associated with a command.
2641 * @qc: Command with memory buffer to be mapped.
2643 * DMA-map the memory buffer associated with queued_cmd @qc.
2646 * spin_lock_irqsave(host_set lock)
2649 * Zero on success, negative on error.
2652 static int ata_sg_setup_one(struct ata_queued_cmd *qc)
2654 struct ata_port *ap = qc->ap;
2655 int dir = qc->dma_dir;
2656 struct scatterlist *sg = qc->__sg;
2657 dma_addr_t dma_address;
2659 /* we must lengthen transfers to end on a 32-bit boundary */
2660 qc->pad_len = sg->length & 3;
2662 void *pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
2663 struct scatterlist *psg = &qc->pad_sgent;
2665 assert(qc->dev->class == ATA_DEV_ATAPI);
2667 memset(pad_buf, 0, ATA_DMA_PAD_SZ);
2669 if (qc->tf.flags & ATA_TFLAG_WRITE)
2670 memcpy(pad_buf, qc->buf_virt + sg->length - qc->pad_len,
2673 sg_dma_address(psg) = ap->pad_dma + (qc->tag * ATA_DMA_PAD_SZ);
2674 sg_dma_len(psg) = ATA_DMA_PAD_SZ;
2676 sg->length -= qc->pad_len;
2678 DPRINTK("padding done, sg->length=%u pad_len=%u\n",
2679 sg->length, qc->pad_len);
2683 sg_dma_address(sg) = 0;
2687 dma_address = dma_map_single(ap->host_set->dev, qc->buf_virt,
2689 if (dma_mapping_error(dma_address)) {
2691 sg->length += qc->pad_len;
2695 sg_dma_address(sg) = dma_address;
2697 sg_dma_len(sg) = sg->length;
2699 DPRINTK("mapped buffer of %d bytes for %s\n", sg_dma_len(sg),
2700 qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
2706 * ata_sg_setup - DMA-map the scatter-gather table associated with a command.
2707 * @qc: Command with scatter-gather table to be mapped.
2709 * DMA-map the scatter-gather table associated with queued_cmd @qc.
2712 * spin_lock_irqsave(host_set lock)
2715 * Zero on success, negative on error.
2719 static int ata_sg_setup(struct ata_queued_cmd *qc)
2721 struct ata_port *ap = qc->ap;
2722 struct scatterlist *sg = qc->__sg;
2723 struct scatterlist *lsg = &sg[qc->n_elem - 1];
2724 int n_elem, pre_n_elem, dir, trim_sg = 0;
2726 VPRINTK("ENTER, ata%u\n", ap->id);
2727 assert(qc->flags & ATA_QCFLAG_SG);
2729 /* we must lengthen transfers to end on a 32-bit boundary */
2730 qc->pad_len = lsg->length & 3;
2732 void *pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
2733 struct scatterlist *psg = &qc->pad_sgent;
2734 unsigned int offset;
2736 assert(qc->dev->class == ATA_DEV_ATAPI);
2738 memset(pad_buf, 0, ATA_DMA_PAD_SZ);
2741 * psg->page/offset are used to copy to-be-written
2742 * data in this function or read data in ata_sg_clean.
2744 offset = lsg->offset + lsg->length - qc->pad_len;
2745 psg->page = nth_page(lsg->page, offset >> PAGE_SHIFT);
2746 psg->offset = offset_in_page(offset);
2748 if (qc->tf.flags & ATA_TFLAG_WRITE) {
2749 void *addr = kmap_atomic(psg->page, KM_IRQ0);
2750 memcpy(pad_buf, addr + psg->offset, qc->pad_len);
2751 kunmap_atomic(addr, KM_IRQ0);
2754 sg_dma_address(psg) = ap->pad_dma + (qc->tag * ATA_DMA_PAD_SZ);
2755 sg_dma_len(psg) = ATA_DMA_PAD_SZ;
2757 lsg->length -= qc->pad_len;
2758 if (lsg->length == 0)
2761 DPRINTK("padding done, sg[%d].length=%u pad_len=%u\n",
2762 qc->n_elem - 1, lsg->length, qc->pad_len);
2765 pre_n_elem = qc->n_elem;
2766 if (trim_sg && pre_n_elem)
2775 n_elem = dma_map_sg(ap->host_set->dev, sg, pre_n_elem, dir);
2777 /* restore last sg */
2778 lsg->length += qc->pad_len;
2782 DPRINTK("%d sg elements mapped\n", n_elem);
2785 qc->n_elem = n_elem;
2791 * ata_poll_qc_complete - turn irq back on and finish qc
2792 * @qc: Command to complete
2793 * @err_mask: ATA status register content
2796 * None. (grabs host lock)
2799 void ata_poll_qc_complete(struct ata_queued_cmd *qc)
2801 struct ata_port *ap = qc->ap;
2802 unsigned long flags;
2804 spin_lock_irqsave(&ap->host_set->lock, flags);
2805 ap->flags &= ~ATA_FLAG_NOINTR;
2807 ata_qc_complete(qc);
2808 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2813 * @ap: the target ata_port
2816 * None. (executing in kernel thread context)
2819 * timeout value to use
2822 static unsigned long ata_pio_poll(struct ata_port *ap)
2824 struct ata_queued_cmd *qc;
2826 unsigned int poll_state = HSM_ST_UNKNOWN;
2827 unsigned int reg_state = HSM_ST_UNKNOWN;
2829 qc = ata_qc_from_tag(ap, ap->active_tag);
2832 switch (ap->hsm_task_state) {
2835 poll_state = HSM_ST_POLL;
2839 case HSM_ST_LAST_POLL:
2840 poll_state = HSM_ST_LAST_POLL;
2841 reg_state = HSM_ST_LAST;
2848 status = ata_chk_status(ap);
2849 if (status & ATA_BUSY) {
2850 if (time_after(jiffies, ap->pio_task_timeout)) {
2851 qc->err_mask |= AC_ERR_ATA_BUS;
2852 ap->hsm_task_state = HSM_ST_TMOUT;
2855 ap->hsm_task_state = poll_state;
2856 return ATA_SHORT_PAUSE;
2859 ap->hsm_task_state = reg_state;
2864 * ata_pio_complete - check if drive is busy or idle
2865 * @ap: the target ata_port
2868 * None. (executing in kernel thread context)
2871 * Non-zero if qc completed, zero otherwise.
2874 static int ata_pio_complete (struct ata_port *ap)
2876 struct ata_queued_cmd *qc;
2880 * This is purely heuristic. This is a fast path. Sometimes when
2881 * we enter, BSY will be cleared in a chk-status or two. If not,
2882 * the drive is probably seeking or something. Snooze for a couple
2883 * msecs, then chk-status again. If still busy, fall back to
2884 * HSM_ST_POLL state.
2886 drv_stat = ata_busy_wait(ap, ATA_BUSY, 10);
2887 if (drv_stat & ATA_BUSY) {
2889 drv_stat = ata_busy_wait(ap, ATA_BUSY, 10);
2890 if (drv_stat & ATA_BUSY) {
2891 ap->hsm_task_state = HSM_ST_LAST_POLL;
2892 ap->pio_task_timeout = jiffies + ATA_TMOUT_PIO;
2897 qc = ata_qc_from_tag(ap, ap->active_tag);
2900 drv_stat = ata_wait_idle(ap);
2901 if (!ata_ok(drv_stat)) {
2902 qc->err_mask |= __ac_err_mask(drv_stat);
2903 ap->hsm_task_state = HSM_ST_ERR;
2907 ap->hsm_task_state = HSM_ST_IDLE;
2909 assert(qc->err_mask == 0);
2910 ata_poll_qc_complete(qc);
2912 /* another command may start at this point */
2919 * swap_buf_le16 - swap halves of 16-words in place
2920 * @buf: Buffer to swap
2921 * @buf_words: Number of 16-bit words in buffer.
2923 * Swap halves of 16-bit words if needed to convert from
2924 * little-endian byte order to native cpu byte order, or
2928 * Inherited from caller.
2930 void swap_buf_le16(u16 *buf, unsigned int buf_words)
2935 for (i = 0; i < buf_words; i++)
2936 buf[i] = le16_to_cpu(buf[i]);
2937 #endif /* __BIG_ENDIAN */
2941 * ata_mmio_data_xfer - Transfer data by MMIO
2942 * @ap: port to read/write
2944 * @buflen: buffer length
2945 * @write_data: read/write
2947 * Transfer data from/to the device data register by MMIO.
2950 * Inherited from caller.
2953 static void ata_mmio_data_xfer(struct ata_port *ap, unsigned char *buf,
2954 unsigned int buflen, int write_data)
2957 unsigned int words = buflen >> 1;
2958 u16 *buf16 = (u16 *) buf;
2959 void __iomem *mmio = (void __iomem *)ap->ioaddr.data_addr;
2961 /* Transfer multiple of 2 bytes */
2963 for (i = 0; i < words; i++)
2964 writew(le16_to_cpu(buf16[i]), mmio);
2966 for (i = 0; i < words; i++)
2967 buf16[i] = cpu_to_le16(readw(mmio));
2970 /* Transfer trailing 1 byte, if any. */
2971 if (unlikely(buflen & 0x01)) {
2972 u16 align_buf[1] = { 0 };
2973 unsigned char *trailing_buf = buf + buflen - 1;
2976 memcpy(align_buf, trailing_buf, 1);
2977 writew(le16_to_cpu(align_buf[0]), mmio);
2979 align_buf[0] = cpu_to_le16(readw(mmio));
2980 memcpy(trailing_buf, align_buf, 1);
2986 * ata_pio_data_xfer - Transfer data by PIO
2987 * @ap: port to read/write
2989 * @buflen: buffer length
2990 * @write_data: read/write
2992 * Transfer data from/to the device data register by PIO.
2995 * Inherited from caller.
2998 static void ata_pio_data_xfer(struct ata_port *ap, unsigned char *buf,
2999 unsigned int buflen, int write_data)
3001 unsigned int words = buflen >> 1;
3003 /* Transfer multiple of 2 bytes */
3005 outsw(ap->ioaddr.data_addr, buf, words);
3007 insw(ap->ioaddr.data_addr, buf, words);
3009 /* Transfer trailing 1 byte, if any. */
3010 if (unlikely(buflen & 0x01)) {
3011 u16 align_buf[1] = { 0 };
3012 unsigned char *trailing_buf = buf + buflen - 1;
3015 memcpy(align_buf, trailing_buf, 1);
3016 outw(le16_to_cpu(align_buf[0]), ap->ioaddr.data_addr);
3018 align_buf[0] = cpu_to_le16(inw(ap->ioaddr.data_addr));
3019 memcpy(trailing_buf, align_buf, 1);
3025 * ata_data_xfer - Transfer data from/to the data register.
3026 * @ap: port to read/write
3028 * @buflen: buffer length
3029 * @do_write: read/write
3031 * Transfer data from/to the device data register.
3034 * Inherited from caller.
3037 static void ata_data_xfer(struct ata_port *ap, unsigned char *buf,
3038 unsigned int buflen, int do_write)
3040 if (ap->flags & ATA_FLAG_MMIO)
3041 ata_mmio_data_xfer(ap, buf, buflen, do_write);
3043 ata_pio_data_xfer(ap, buf, buflen, do_write);
3047 * ata_pio_sector - Transfer ATA_SECT_SIZE (512 bytes) of data.
3048 * @qc: Command on going
3050 * Transfer ATA_SECT_SIZE of data from/to the ATA device.
3053 * Inherited from caller.
3056 static void ata_pio_sector(struct ata_queued_cmd *qc)
3058 int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
3059 struct scatterlist *sg = qc->__sg;
3060 struct ata_port *ap = qc->ap;
3062 unsigned int offset;
3065 if (qc->cursect == (qc->nsect - 1))
3066 ap->hsm_task_state = HSM_ST_LAST;
3068 page = sg[qc->cursg].page;
3069 offset = sg[qc->cursg].offset + qc->cursg_ofs * ATA_SECT_SIZE;
3071 /* get the current page and offset */
3072 page = nth_page(page, (offset >> PAGE_SHIFT));
3073 offset %= PAGE_SIZE;
3075 buf = kmap(page) + offset;
3080 if ((qc->cursg_ofs * ATA_SECT_SIZE) == (&sg[qc->cursg])->length) {
3085 DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
3087 /* do the actual data transfer */
3088 do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
3089 ata_data_xfer(ap, buf, ATA_SECT_SIZE, do_write);
3095 * __atapi_pio_bytes - Transfer data from/to the ATAPI device.
3096 * @qc: Command on going
3097 * @bytes: number of bytes
3099 * Transfer Transfer data from/to the ATAPI device.
3102 * Inherited from caller.
3106 static void __atapi_pio_bytes(struct ata_queued_cmd *qc, unsigned int bytes)
3108 int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
3109 struct scatterlist *sg = qc->__sg;
3110 struct ata_port *ap = qc->ap;
3113 unsigned int offset, count;
3115 if (qc->curbytes + bytes >= qc->nbytes)
3116 ap->hsm_task_state = HSM_ST_LAST;
3119 if (unlikely(qc->cursg >= qc->n_elem)) {
3121 * The end of qc->sg is reached and the device expects
3122 * more data to transfer. In order not to overrun qc->sg
3123 * and fulfill length specified in the byte count register,
3124 * - for read case, discard trailing data from the device
3125 * - for write case, padding zero data to the device
3127 u16 pad_buf[1] = { 0 };
3128 unsigned int words = bytes >> 1;
3131 if (words) /* warning if bytes > 1 */
3132 printk(KERN_WARNING "ata%u: %u bytes trailing data\n",
3135 for (i = 0; i < words; i++)
3136 ata_data_xfer(ap, (unsigned char*)pad_buf, 2, do_write);
3138 ap->hsm_task_state = HSM_ST_LAST;
3142 sg = &qc->__sg[qc->cursg];
3145 offset = sg->offset + qc->cursg_ofs;
3147 /* get the current page and offset */
3148 page = nth_page(page, (offset >> PAGE_SHIFT));
3149 offset %= PAGE_SIZE;
3151 /* don't overrun current sg */
3152 count = min(sg->length - qc->cursg_ofs, bytes);
3154 /* don't cross page boundaries */
3155 count = min(count, (unsigned int)PAGE_SIZE - offset);
3157 buf = kmap(page) + offset;
3160 qc->curbytes += count;
3161 qc->cursg_ofs += count;
3163 if (qc->cursg_ofs == sg->length) {
3168 DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
3170 /* do the actual data transfer */
3171 ata_data_xfer(ap, buf, count, do_write);
3180 * atapi_pio_bytes - Transfer data from/to the ATAPI device.
3181 * @qc: Command on going
3183 * Transfer Transfer data from/to the ATAPI device.
3186 * Inherited from caller.
3189 static void atapi_pio_bytes(struct ata_queued_cmd *qc)
3191 struct ata_port *ap = qc->ap;
3192 struct ata_device *dev = qc->dev;
3193 unsigned int ireason, bc_lo, bc_hi, bytes;
3194 int i_write, do_write = (qc->tf.flags & ATA_TFLAG_WRITE) ? 1 : 0;
3196 ap->ops->tf_read(ap, &qc->tf);
3197 ireason = qc->tf.nsect;
3198 bc_lo = qc->tf.lbam;
3199 bc_hi = qc->tf.lbah;
3200 bytes = (bc_hi << 8) | bc_lo;
3202 /* shall be cleared to zero, indicating xfer of data */
3203 if (ireason & (1 << 0))
3206 /* make sure transfer direction matches expected */
3207 i_write = ((ireason & (1 << 1)) == 0) ? 1 : 0;
3208 if (do_write != i_write)
3211 __atapi_pio_bytes(qc, bytes);
3216 printk(KERN_INFO "ata%u: dev %u: ATAPI check failed\n",
3217 ap->id, dev->devno);
3218 qc->err_mask |= AC_ERR_ATA_BUS;
3219 ap->hsm_task_state = HSM_ST_ERR;
3223 * ata_pio_block - start PIO on a block
3224 * @ap: the target ata_port
3227 * None. (executing in kernel thread context)
3230 static void ata_pio_block(struct ata_port *ap)
3232 struct ata_queued_cmd *qc;
3236 * This is purely heuristic. This is a fast path.
3237 * Sometimes when we enter, BSY will be cleared in
3238 * a chk-status or two. If not, the drive is probably seeking
3239 * or something. Snooze for a couple msecs, then
3240 * chk-status again. If still busy, fall back to
3241 * HSM_ST_POLL state.
3243 status = ata_busy_wait(ap, ATA_BUSY, 5);
3244 if (status & ATA_BUSY) {
3246 status = ata_busy_wait(ap, ATA_BUSY, 10);
3247 if (status & ATA_BUSY) {
3248 ap->hsm_task_state = HSM_ST_POLL;
3249 ap->pio_task_timeout = jiffies + ATA_TMOUT_PIO;
3254 qc = ata_qc_from_tag(ap, ap->active_tag);
3258 if (status & (ATA_ERR | ATA_DF)) {
3259 qc->err_mask |= AC_ERR_DEV;
3260 ap->hsm_task_state = HSM_ST_ERR;
3264 /* transfer data if any */
3265 if (is_atapi_taskfile(&qc->tf)) {
3266 /* DRQ=0 means no more data to transfer */
3267 if ((status & ATA_DRQ) == 0) {
3268 ap->hsm_task_state = HSM_ST_LAST;
3272 atapi_pio_bytes(qc);
3274 /* handle BSY=0, DRQ=0 as error */
3275 if ((status & ATA_DRQ) == 0) {
3276 qc->err_mask |= AC_ERR_ATA_BUS;
3277 ap->hsm_task_state = HSM_ST_ERR;
3285 static void ata_pio_error(struct ata_port *ap)
3287 struct ata_queued_cmd *qc;
3289 printk(KERN_WARNING "ata%u: PIO error\n", ap->id);
3291 qc = ata_qc_from_tag(ap, ap->active_tag);
3294 /* make sure qc->err_mask is available to
3295 * know what's wrong and recover
3297 assert(qc->err_mask);
3299 ap->hsm_task_state = HSM_ST_IDLE;
3301 ata_poll_qc_complete(qc);
3304 static void ata_pio_task(void *_data)
3306 struct ata_port *ap = _data;
3307 unsigned long timeout;
3314 switch (ap->hsm_task_state) {
3323 qc_completed = ata_pio_complete(ap);
3327 case HSM_ST_LAST_POLL:
3328 timeout = ata_pio_poll(ap);
3338 queue_delayed_work(ata_wq, &ap->pio_task, timeout);
3339 else if (!qc_completed)
3344 * ata_qc_timeout - Handle timeout of queued command
3345 * @qc: Command that timed out
3347 * Some part of the kernel (currently, only the SCSI layer)
3348 * has noticed that the active command on port @ap has not
3349 * completed after a specified length of time. Handle this
3350 * condition by disabling DMA (if necessary) and completing
3351 * transactions, with error if necessary.
3353 * This also handles the case of the "lost interrupt", where
3354 * for some reason (possibly hardware bug, possibly driver bug)
3355 * an interrupt was not delivered to the driver, even though the
3356 * transaction completed successfully.
3359 * Inherited from SCSI layer (none, can sleep)
3362 static void ata_qc_timeout(struct ata_queued_cmd *qc)
3364 struct ata_port *ap = qc->ap;
3365 struct ata_host_set *host_set = ap->host_set;
3366 u8 host_stat = 0, drv_stat;
3367 unsigned long flags;
3371 spin_lock_irqsave(&host_set->lock, flags);
3373 /* hack alert! We cannot use the supplied completion
3374 * function from inside the ->eh_strategy_handler() thread.
3375 * libata is the only user of ->eh_strategy_handler() in
3376 * any kernel, so the default scsi_done() assumes it is
3377 * not being called from the SCSI EH.
3379 qc->scsidone = scsi_finish_command;
3381 switch (qc->tf.protocol) {
3384 case ATA_PROT_ATAPI_DMA:
3385 host_stat = ap->ops->bmdma_status(ap);
3387 /* before we do anything else, clear DMA-Start bit */
3388 ap->ops->bmdma_stop(qc);
3394 drv_stat = ata_chk_status(ap);
3396 /* ack bmdma irq events */
3397 ap->ops->irq_clear(ap);
3399 printk(KERN_ERR "ata%u: command 0x%x timeout, stat 0x%x host_stat 0x%x\n",
3400 ap->id, qc->tf.command, drv_stat, host_stat);
3402 /* complete taskfile transaction */
3403 qc->err_mask |= ac_err_mask(drv_stat);
3404 ata_qc_complete(qc);
3408 spin_unlock_irqrestore(&host_set->lock, flags);
3414 * ata_eng_timeout - Handle timeout of queued command
3415 * @ap: Port on which timed-out command is active
3417 * Some part of the kernel (currently, only the SCSI layer)
3418 * has noticed that the active command on port @ap has not
3419 * completed after a specified length of time. Handle this
3420 * condition by disabling DMA (if necessary) and completing
3421 * transactions, with error if necessary.
3423 * This also handles the case of the "lost interrupt", where
3424 * for some reason (possibly hardware bug, possibly driver bug)
3425 * an interrupt was not delivered to the driver, even though the
3426 * transaction completed successfully.
3429 * Inherited from SCSI layer (none, can sleep)
3432 void ata_eng_timeout(struct ata_port *ap)
3434 struct ata_queued_cmd *qc;
3438 qc = ata_qc_from_tag(ap, ap->active_tag);
3442 printk(KERN_ERR "ata%u: BUG: timeout without command\n",
3452 * ata_qc_new - Request an available ATA command, for queueing
3453 * @ap: Port associated with device @dev
3454 * @dev: Device from whom we request an available command structure
3460 static struct ata_queued_cmd *ata_qc_new(struct ata_port *ap)
3462 struct ata_queued_cmd *qc = NULL;
3465 for (i = 0; i < ATA_MAX_QUEUE; i++)
3466 if (!test_and_set_bit(i, &ap->qactive)) {
3467 qc = ata_qc_from_tag(ap, i);
3478 * ata_qc_new_init - Request an available ATA command, and initialize it
3479 * @ap: Port associated with device @dev
3480 * @dev: Device from whom we request an available command structure
3486 struct ata_queued_cmd *ata_qc_new_init(struct ata_port *ap,
3487 struct ata_device *dev)
3489 struct ata_queued_cmd *qc;
3491 qc = ata_qc_new(ap);
3503 static void __ata_qc_complete(struct ata_queued_cmd *qc)
3505 struct ata_port *ap = qc->ap;
3510 if (likely(ata_tag_valid(tag))) {
3511 if (tag == ap->active_tag)
3512 ap->active_tag = ATA_TAG_POISON;
3513 qc->tag = ATA_TAG_POISON;
3514 clear_bit(tag, &ap->qactive);
3519 * ata_qc_free - free unused ata_queued_cmd
3520 * @qc: Command to complete
3522 * Designed to free unused ata_queued_cmd object
3523 * in case something prevents using it.
3526 * spin_lock_irqsave(host_set lock)
3528 void ata_qc_free(struct ata_queued_cmd *qc)
3530 assert(qc != NULL); /* ata_qc_from_tag _might_ return NULL */
3532 __ata_qc_complete(qc);
3536 * ata_qc_complete - Complete an active ATA command
3537 * @qc: Command to complete
3538 * @err_mask: ATA Status register contents
3540 * Indicate to the mid and upper layers that an ATA
3541 * command has completed, with either an ok or not-ok status.
3544 * spin_lock_irqsave(host_set lock)
3547 void ata_qc_complete(struct ata_queued_cmd *qc)
3551 assert(qc != NULL); /* ata_qc_from_tag _might_ return NULL */
3552 assert(qc->flags & ATA_QCFLAG_ACTIVE);
3554 if (likely(qc->flags & ATA_QCFLAG_DMAMAP))
3557 /* atapi: mark qc as inactive to prevent the interrupt handler
3558 * from completing the command twice later, before the error handler
3559 * is called. (when rc != 0 and atapi request sense is needed)
3561 qc->flags &= ~ATA_QCFLAG_ACTIVE;
3563 /* call completion callback */
3564 rc = qc->complete_fn(qc);
3566 /* if callback indicates not to complete command (non-zero),
3567 * return immediately
3572 __ata_qc_complete(qc);
3577 static inline int ata_should_dma_map(struct ata_queued_cmd *qc)
3579 struct ata_port *ap = qc->ap;
3581 switch (qc->tf.protocol) {
3583 case ATA_PROT_ATAPI_DMA:
3586 case ATA_PROT_ATAPI:
3588 case ATA_PROT_PIO_MULT:
3589 if (ap->flags & ATA_FLAG_PIO_DMA)
3602 * ata_qc_issue - issue taskfile to device
3603 * @qc: command to issue to device
3605 * Prepare an ATA command to submission to device.
3606 * This includes mapping the data into a DMA-able
3607 * area, filling in the S/G table, and finally
3608 * writing the taskfile to hardware, starting the command.
3611 * spin_lock_irqsave(host_set lock)
3614 * Zero on success, negative on error.
3617 int ata_qc_issue(struct ata_queued_cmd *qc)
3619 struct ata_port *ap = qc->ap;
3621 if (ata_should_dma_map(qc)) {
3622 if (qc->flags & ATA_QCFLAG_SG) {
3623 if (ata_sg_setup(qc))
3625 } else if (qc->flags & ATA_QCFLAG_SINGLE) {
3626 if (ata_sg_setup_one(qc))
3630 qc->flags &= ~ATA_QCFLAG_DMAMAP;
3633 ap->ops->qc_prep(qc);
3635 qc->ap->active_tag = qc->tag;
3636 qc->flags |= ATA_QCFLAG_ACTIVE;
3638 return ap->ops->qc_issue(qc);
3646 * ata_qc_issue_prot - issue taskfile to device in proto-dependent manner
3647 * @qc: command to issue to device
3649 * Using various libata functions and hooks, this function
3650 * starts an ATA command. ATA commands are grouped into
3651 * classes called "protocols", and issuing each type of protocol
3652 * is slightly different.
3654 * May be used as the qc_issue() entry in ata_port_operations.
3657 * spin_lock_irqsave(host_set lock)
3660 * Zero on success, negative on error.
3663 int ata_qc_issue_prot(struct ata_queued_cmd *qc)
3665 struct ata_port *ap = qc->ap;
3667 ata_dev_select(ap, qc->dev->devno, 1, 0);
3669 switch (qc->tf.protocol) {
3670 case ATA_PROT_NODATA:
3671 ata_tf_to_host(ap, &qc->tf);
3675 ap->ops->tf_load(ap, &qc->tf); /* load tf registers */
3676 ap->ops->bmdma_setup(qc); /* set up bmdma */
3677 ap->ops->bmdma_start(qc); /* initiate bmdma */
3680 case ATA_PROT_PIO: /* load tf registers, initiate polling pio */
3681 ata_qc_set_polling(qc);
3682 ata_tf_to_host(ap, &qc->tf);
3683 ap->hsm_task_state = HSM_ST;
3684 queue_work(ata_wq, &ap->pio_task);
3687 case ATA_PROT_ATAPI:
3688 ata_qc_set_polling(qc);
3689 ata_tf_to_host(ap, &qc->tf);
3690 queue_work(ata_wq, &ap->packet_task);
3693 case ATA_PROT_ATAPI_NODATA:
3694 ap->flags |= ATA_FLAG_NOINTR;
3695 ata_tf_to_host(ap, &qc->tf);
3696 queue_work(ata_wq, &ap->packet_task);
3699 case ATA_PROT_ATAPI_DMA:
3700 ap->flags |= ATA_FLAG_NOINTR;
3701 ap->ops->tf_load(ap, &qc->tf); /* load tf registers */
3702 ap->ops->bmdma_setup(qc); /* set up bmdma */
3703 queue_work(ata_wq, &ap->packet_task);
3715 * ata_bmdma_setup_mmio - Set up PCI IDE BMDMA transaction
3716 * @qc: Info associated with this ATA transaction.
3719 * spin_lock_irqsave(host_set lock)
3722 static void ata_bmdma_setup_mmio (struct ata_queued_cmd *qc)
3724 struct ata_port *ap = qc->ap;
3725 unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
3727 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
3729 /* load PRD table addr. */
3730 mb(); /* make sure PRD table writes are visible to controller */
3731 writel(ap->prd_dma, mmio + ATA_DMA_TABLE_OFS);
3733 /* specify data direction, triple-check start bit is clear */
3734 dmactl = readb(mmio + ATA_DMA_CMD);
3735 dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
3737 dmactl |= ATA_DMA_WR;
3738 writeb(dmactl, mmio + ATA_DMA_CMD);
3740 /* issue r/w command */
3741 ap->ops->exec_command(ap, &qc->tf);
3745 * ata_bmdma_start_mmio - Start a PCI IDE BMDMA transaction
3746 * @qc: Info associated with this ATA transaction.
3749 * spin_lock_irqsave(host_set lock)
3752 static void ata_bmdma_start_mmio (struct ata_queued_cmd *qc)
3754 struct ata_port *ap = qc->ap;
3755 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
3758 /* start host DMA transaction */
3759 dmactl = readb(mmio + ATA_DMA_CMD);
3760 writeb(dmactl | ATA_DMA_START, mmio + ATA_DMA_CMD);
3762 /* Strictly, one may wish to issue a readb() here, to
3763 * flush the mmio write. However, control also passes
3764 * to the hardware at this point, and it will interrupt
3765 * us when we are to resume control. So, in effect,
3766 * we don't care when the mmio write flushes.
3767 * Further, a read of the DMA status register _immediately_
3768 * following the write may not be what certain flaky hardware
3769 * is expected, so I think it is best to not add a readb()
3770 * without first all the MMIO ATA cards/mobos.
3771 * Or maybe I'm just being paranoid.
3776 * ata_bmdma_setup_pio - Set up PCI IDE BMDMA transaction (PIO)
3777 * @qc: Info associated with this ATA transaction.
3780 * spin_lock_irqsave(host_set lock)
3783 static void ata_bmdma_setup_pio (struct ata_queued_cmd *qc)
3785 struct ata_port *ap = qc->ap;
3786 unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
3789 /* load PRD table addr. */
3790 outl(ap->prd_dma, ap->ioaddr.bmdma_addr + ATA_DMA_TABLE_OFS);
3792 /* specify data direction, triple-check start bit is clear */
3793 dmactl = inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3794 dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
3796 dmactl |= ATA_DMA_WR;
3797 outb(dmactl, ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3799 /* issue r/w command */
3800 ap->ops->exec_command(ap, &qc->tf);
3804 * ata_bmdma_start_pio - Start a PCI IDE BMDMA transaction (PIO)
3805 * @qc: Info associated with this ATA transaction.
3808 * spin_lock_irqsave(host_set lock)
3811 static void ata_bmdma_start_pio (struct ata_queued_cmd *qc)
3813 struct ata_port *ap = qc->ap;
3816 /* start host DMA transaction */
3817 dmactl = inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3818 outb(dmactl | ATA_DMA_START,
3819 ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3824 * ata_bmdma_start - Start a PCI IDE BMDMA transaction
3825 * @qc: Info associated with this ATA transaction.
3827 * Writes the ATA_DMA_START flag to the DMA command register.
3829 * May be used as the bmdma_start() entry in ata_port_operations.
3832 * spin_lock_irqsave(host_set lock)
3834 void ata_bmdma_start(struct ata_queued_cmd *qc)
3836 if (qc->ap->flags & ATA_FLAG_MMIO)
3837 ata_bmdma_start_mmio(qc);
3839 ata_bmdma_start_pio(qc);
3844 * ata_bmdma_setup - Set up PCI IDE BMDMA transaction
3845 * @qc: Info associated with this ATA transaction.
3847 * Writes address of PRD table to device's PRD Table Address
3848 * register, sets the DMA control register, and calls
3849 * ops->exec_command() to start the transfer.
3851 * May be used as the bmdma_setup() entry in ata_port_operations.
3854 * spin_lock_irqsave(host_set lock)
3856 void ata_bmdma_setup(struct ata_queued_cmd *qc)
3858 if (qc->ap->flags & ATA_FLAG_MMIO)
3859 ata_bmdma_setup_mmio(qc);
3861 ata_bmdma_setup_pio(qc);
3866 * ata_bmdma_irq_clear - Clear PCI IDE BMDMA interrupt.
3867 * @ap: Port associated with this ATA transaction.
3869 * Clear interrupt and error flags in DMA status register.
3871 * May be used as the irq_clear() entry in ata_port_operations.
3874 * spin_lock_irqsave(host_set lock)
3877 void ata_bmdma_irq_clear(struct ata_port *ap)
3879 if (ap->flags & ATA_FLAG_MMIO) {
3880 void __iomem *mmio = ((void __iomem *) ap->ioaddr.bmdma_addr) + ATA_DMA_STATUS;
3881 writeb(readb(mmio), mmio);
3883 unsigned long addr = ap->ioaddr.bmdma_addr + ATA_DMA_STATUS;
3884 outb(inb(addr), addr);
3891 * ata_bmdma_status - Read PCI IDE BMDMA status
3892 * @ap: Port associated with this ATA transaction.
3894 * Read and return BMDMA status register.
3896 * May be used as the bmdma_status() entry in ata_port_operations.
3899 * spin_lock_irqsave(host_set lock)
3902 u8 ata_bmdma_status(struct ata_port *ap)
3905 if (ap->flags & ATA_FLAG_MMIO) {
3906 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
3907 host_stat = readb(mmio + ATA_DMA_STATUS);
3909 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
3915 * ata_bmdma_stop - Stop PCI IDE BMDMA transfer
3916 * @qc: Command we are ending DMA for
3918 * Clears the ATA_DMA_START flag in the dma control register
3920 * May be used as the bmdma_stop() entry in ata_port_operations.
3923 * spin_lock_irqsave(host_set lock)
3926 void ata_bmdma_stop(struct ata_queued_cmd *qc)
3928 struct ata_port *ap = qc->ap;
3929 if (ap->flags & ATA_FLAG_MMIO) {
3930 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
3932 /* clear start/stop bit */
3933 writeb(readb(mmio + ATA_DMA_CMD) & ~ATA_DMA_START,
3934 mmio + ATA_DMA_CMD);
3936 /* clear start/stop bit */
3937 outb(inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD) & ~ATA_DMA_START,
3938 ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
3941 /* one-PIO-cycle guaranteed wait, per spec, for HDMA1:0 transition */
3942 ata_altstatus(ap); /* dummy read */
3946 * ata_host_intr - Handle host interrupt for given (port, task)
3947 * @ap: Port on which interrupt arrived (possibly...)
3948 * @qc: Taskfile currently active in engine
3950 * Handle host interrupt for given queued command. Currently,
3951 * only DMA interrupts are handled. All other commands are
3952 * handled via polling with interrupts disabled (nIEN bit).
3955 * spin_lock_irqsave(host_set lock)
3958 * One if interrupt was handled, zero if not (shared irq).
3961 inline unsigned int ata_host_intr (struct ata_port *ap,
3962 struct ata_queued_cmd *qc)
3964 u8 status, host_stat;
3966 switch (qc->tf.protocol) {
3969 case ATA_PROT_ATAPI_DMA:
3970 case ATA_PROT_ATAPI:
3971 /* check status of DMA engine */
3972 host_stat = ap->ops->bmdma_status(ap);
3973 VPRINTK("ata%u: host_stat 0x%X\n", ap->id, host_stat);
3975 /* if it's not our irq... */
3976 if (!(host_stat & ATA_DMA_INTR))
3979 /* before we do anything else, clear DMA-Start bit */
3980 ap->ops->bmdma_stop(qc);
3984 case ATA_PROT_ATAPI_NODATA:
3985 case ATA_PROT_NODATA:
3986 /* check altstatus */
3987 status = ata_altstatus(ap);
3988 if (status & ATA_BUSY)
3991 /* check main status, clearing INTRQ */
3992 status = ata_chk_status(ap);
3993 if (unlikely(status & ATA_BUSY))
3995 DPRINTK("ata%u: protocol %d (dev_stat 0x%X)\n",
3996 ap->id, qc->tf.protocol, status);
3998 /* ack bmdma irq events */
3999 ap->ops->irq_clear(ap);
4001 /* complete taskfile transaction */
4002 qc->err_mask |= ac_err_mask(status);
4003 ata_qc_complete(qc);
4010 return 1; /* irq handled */
4013 ap->stats.idle_irq++;
4016 if ((ap->stats.idle_irq % 1000) == 0) {
4018 ata_irq_ack(ap, 0); /* debug trap */
4019 printk(KERN_WARNING "ata%d: irq trap\n", ap->id);
4022 return 0; /* irq not handled */
4026 * ata_interrupt - Default ATA host interrupt handler
4027 * @irq: irq line (unused)
4028 * @dev_instance: pointer to our ata_host_set information structure
4031 * Default interrupt handler for PCI IDE devices. Calls
4032 * ata_host_intr() for each port that is not disabled.
4035 * Obtains host_set lock during operation.
4038 * IRQ_NONE or IRQ_HANDLED.
4041 irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
4043 struct ata_host_set *host_set = dev_instance;
4045 unsigned int handled = 0;
4046 unsigned long flags;
4048 /* TODO: make _irqsave conditional on x86 PCI IDE legacy mode */
4049 spin_lock_irqsave(&host_set->lock, flags);
4051 for (i = 0; i < host_set->n_ports; i++) {
4052 struct ata_port *ap;
4054 ap = host_set->ports[i];
4056 !(ap->flags & (ATA_FLAG_PORT_DISABLED | ATA_FLAG_NOINTR))) {
4057 struct ata_queued_cmd *qc;
4059 qc = ata_qc_from_tag(ap, ap->active_tag);
4060 if (qc && (!(qc->tf.ctl & ATA_NIEN)) &&
4061 (qc->flags & ATA_QCFLAG_ACTIVE))
4062 handled |= ata_host_intr(ap, qc);
4066 spin_unlock_irqrestore(&host_set->lock, flags);
4068 return IRQ_RETVAL(handled);
4072 * atapi_packet_task - Write CDB bytes to hardware
4073 * @_data: Port to which ATAPI device is attached.
4075 * When device has indicated its readiness to accept
4076 * a CDB, this function is called. Send the CDB.
4077 * If DMA is to be performed, exit immediately.
4078 * Otherwise, we are in polling mode, so poll
4079 * status under operation succeeds or fails.
4082 * Kernel thread context (may sleep)
4085 static void atapi_packet_task(void *_data)
4087 struct ata_port *ap = _data;
4088 struct ata_queued_cmd *qc;
4091 qc = ata_qc_from_tag(ap, ap->active_tag);
4093 assert(qc->flags & ATA_QCFLAG_ACTIVE);
4095 /* sleep-wait for BSY to clear */
4096 DPRINTK("busy wait\n");
4097 if (ata_busy_sleep(ap, ATA_TMOUT_CDB_QUICK, ATA_TMOUT_CDB)) {
4098 qc->err_mask |= AC_ERR_ATA_BUS;
4102 /* make sure DRQ is set */
4103 status = ata_chk_status(ap);
4104 if ((status & (ATA_BUSY | ATA_DRQ)) != ATA_DRQ) {
4105 qc->err_mask |= AC_ERR_ATA_BUS;
4110 DPRINTK("send cdb\n");
4111 assert(ap->cdb_len >= 12);
4113 if (qc->tf.protocol == ATA_PROT_ATAPI_DMA ||
4114 qc->tf.protocol == ATA_PROT_ATAPI_NODATA) {
4115 unsigned long flags;
4117 /* Once we're done issuing command and kicking bmdma,
4118 * irq handler takes over. To not lose irq, we need
4119 * to clear NOINTR flag before sending cdb, but
4120 * interrupt handler shouldn't be invoked before we're
4121 * finished. Hence, the following locking.
4123 spin_lock_irqsave(&ap->host_set->lock, flags);
4124 ap->flags &= ~ATA_FLAG_NOINTR;
4125 ata_data_xfer(ap, qc->cdb, ap->cdb_len, 1);
4126 if (qc->tf.protocol == ATA_PROT_ATAPI_DMA)
4127 ap->ops->bmdma_start(qc); /* initiate bmdma */
4128 spin_unlock_irqrestore(&ap->host_set->lock, flags);
4130 ata_data_xfer(ap, qc->cdb, ap->cdb_len, 1);
4132 /* PIO commands are handled by polling */
4133 ap->hsm_task_state = HSM_ST;
4134 queue_work(ata_wq, &ap->pio_task);
4140 ata_poll_qc_complete(qc);
4145 * ata_port_start - Set port up for dma.
4146 * @ap: Port to initialize
4148 * Called just after data structures for each port are
4149 * initialized. Allocates space for PRD table.
4151 * May be used as the port_start() entry in ata_port_operations.
4154 * Inherited from caller.
4157 int ata_port_start (struct ata_port *ap)
4159 struct device *dev = ap->host_set->dev;
4162 ap->prd = dma_alloc_coherent(dev, ATA_PRD_TBL_SZ, &ap->prd_dma, GFP_KERNEL);
4166 rc = ata_pad_alloc(ap, dev);
4168 dma_free_coherent(dev, ATA_PRD_TBL_SZ, ap->prd, ap->prd_dma);
4172 DPRINTK("prd alloc, virt %p, dma %llx\n", ap->prd, (unsigned long long) ap->prd_dma);
4179 * ata_port_stop - Undo ata_port_start()
4180 * @ap: Port to shut down
4182 * Frees the PRD table.
4184 * May be used as the port_stop() entry in ata_port_operations.
4187 * Inherited from caller.
4190 void ata_port_stop (struct ata_port *ap)
4192 struct device *dev = ap->host_set->dev;
4194 dma_free_coherent(dev, ATA_PRD_TBL_SZ, ap->prd, ap->prd_dma);
4195 ata_pad_free(ap, dev);
4198 void ata_host_stop (struct ata_host_set *host_set)
4200 if (host_set->mmio_base)
4201 iounmap(host_set->mmio_base);
4206 * ata_host_remove - Unregister SCSI host structure with upper layers
4207 * @ap: Port to unregister
4208 * @do_unregister: 1 if we fully unregister, 0 to just stop the port
4211 * Inherited from caller.
4214 static void ata_host_remove(struct ata_port *ap, unsigned int do_unregister)
4216 struct Scsi_Host *sh = ap->host;
4221 scsi_remove_host(sh);
4223 ap->ops->port_stop(ap);
4227 * ata_host_init - Initialize an ata_port structure
4228 * @ap: Structure to initialize
4229 * @host: associated SCSI mid-layer structure
4230 * @host_set: Collection of hosts to which @ap belongs
4231 * @ent: Probe information provided by low-level driver
4232 * @port_no: Port number associated with this ata_port
4234 * Initialize a new ata_port structure, and its associated
4238 * Inherited from caller.
4241 static void ata_host_init(struct ata_port *ap, struct Scsi_Host *host,
4242 struct ata_host_set *host_set,
4243 const struct ata_probe_ent *ent, unsigned int port_no)
4249 host->max_channel = 1;
4250 host->unique_id = ata_unique_id++;
4251 host->max_cmd_len = 12;
4253 ap->flags = ATA_FLAG_PORT_DISABLED;
4254 ap->id = host->unique_id;
4256 ap->ctl = ATA_DEVCTL_OBS;
4257 ap->host_set = host_set;
4258 ap->port_no = port_no;
4260 ent->legacy_mode ? ent->hard_port_no : port_no;
4261 ap->pio_mask = ent->pio_mask;
4262 ap->mwdma_mask = ent->mwdma_mask;
4263 ap->udma_mask = ent->udma_mask;
4264 ap->flags |= ent->host_flags;
4265 ap->ops = ent->port_ops;
4266 ap->cbl = ATA_CBL_NONE;
4267 ap->active_tag = ATA_TAG_POISON;
4268 ap->last_ctl = 0xFF;
4270 INIT_WORK(&ap->packet_task, atapi_packet_task, ap);
4271 INIT_WORK(&ap->pio_task, ata_pio_task, ap);
4273 for (i = 0; i < ATA_MAX_DEVICES; i++)
4274 ap->device[i].devno = i;
4277 ap->stats.unhandled_irq = 1;
4278 ap->stats.idle_irq = 1;
4281 memcpy(&ap->ioaddr, &ent->port[port_no], sizeof(struct ata_ioports));
4285 * ata_host_add - Attach low-level ATA driver to system
4286 * @ent: Information provided by low-level driver
4287 * @host_set: Collections of ports to which we add
4288 * @port_no: Port number associated with this host
4290 * Attach low-level ATA driver to system.
4293 * PCI/etc. bus probe sem.
4296 * New ata_port on success, for NULL on error.
4299 static struct ata_port * ata_host_add(const struct ata_probe_ent *ent,
4300 struct ata_host_set *host_set,
4301 unsigned int port_no)
4303 struct Scsi_Host *host;
4304 struct ata_port *ap;
4308 host = scsi_host_alloc(ent->sht, sizeof(struct ata_port));
4312 ap = (struct ata_port *) &host->hostdata[0];
4314 ata_host_init(ap, host, host_set, ent, port_no);
4316 rc = ap->ops->port_start(ap);
4323 scsi_host_put(host);
4328 * ata_device_add - Register hardware device with ATA and SCSI layers
4329 * @ent: Probe information describing hardware device to be registered
4331 * This function processes the information provided in the probe
4332 * information struct @ent, allocates the necessary ATA and SCSI
4333 * host information structures, initializes them, and registers
4334 * everything with requisite kernel subsystems.
4336 * This function requests irqs, probes the ATA bus, and probes
4340 * PCI/etc. bus probe sem.
4343 * Number of ports registered. Zero on error (no ports registered).
4346 int ata_device_add(const struct ata_probe_ent *ent)
4348 unsigned int count = 0, i;
4349 struct device *dev = ent->dev;
4350 struct ata_host_set *host_set;
4353 /* alloc a container for our list of ATA ports (buses) */
4354 host_set = kzalloc(sizeof(struct ata_host_set) +
4355 (ent->n_ports * sizeof(void *)), GFP_KERNEL);
4358 spin_lock_init(&host_set->lock);
4360 host_set->dev = dev;
4361 host_set->n_ports = ent->n_ports;
4362 host_set->irq = ent->irq;
4363 host_set->mmio_base = ent->mmio_base;
4364 host_set->private_data = ent->private_data;
4365 host_set->ops = ent->port_ops;
4367 /* register each port bound to this device */
4368 for (i = 0; i < ent->n_ports; i++) {
4369 struct ata_port *ap;
4370 unsigned long xfer_mode_mask;
4372 ap = ata_host_add(ent, host_set, i);
4376 host_set->ports[i] = ap;
4377 xfer_mode_mask =(ap->udma_mask << ATA_SHIFT_UDMA) |
4378 (ap->mwdma_mask << ATA_SHIFT_MWDMA) |
4379 (ap->pio_mask << ATA_SHIFT_PIO);
4381 /* print per-port info to dmesg */
4382 printk(KERN_INFO "ata%u: %cATA max %s cmd 0x%lX ctl 0x%lX "
4383 "bmdma 0x%lX irq %lu\n",
4385 ap->flags & ATA_FLAG_SATA ? 'S' : 'P',
4386 ata_mode_string(xfer_mode_mask),
4387 ap->ioaddr.cmd_addr,
4388 ap->ioaddr.ctl_addr,
4389 ap->ioaddr.bmdma_addr,
4393 host_set->ops->irq_clear(ap);
4400 /* obtain irq, that is shared between channels */
4401 if (request_irq(ent->irq, ent->port_ops->irq_handler, ent->irq_flags,
4402 DRV_NAME, host_set))
4405 /* perform each probe synchronously */
4406 DPRINTK("probe begin\n");
4407 for (i = 0; i < count; i++) {
4408 struct ata_port *ap;
4411 ap = host_set->ports[i];
4413 DPRINTK("ata%u: probe begin\n", ap->id);
4414 rc = ata_bus_probe(ap);
4415 DPRINTK("ata%u: probe end\n", ap->id);
4418 /* FIXME: do something useful here?
4419 * Current libata behavior will
4420 * tear down everything when
4421 * the module is removed
4422 * or the h/w is unplugged.
4426 rc = scsi_add_host(ap->host, dev);
4428 printk(KERN_ERR "ata%u: scsi_add_host failed\n",
4430 /* FIXME: do something useful here */
4431 /* FIXME: handle unconditional calls to
4432 * scsi_scan_host and ata_host_remove, below,
4438 /* probes are done, now scan each port's disk(s) */
4439 DPRINTK("probe begin\n");
4440 for (i = 0; i < count; i++) {
4441 struct ata_port *ap = host_set->ports[i];
4443 ata_scsi_scan_host(ap);
4446 dev_set_drvdata(dev, host_set);
4448 VPRINTK("EXIT, returning %u\n", ent->n_ports);
4449 return ent->n_ports; /* success */
4452 for (i = 0; i < count; i++) {
4453 ata_host_remove(host_set->ports[i], 1);
4454 scsi_host_put(host_set->ports[i]->host);
4458 VPRINTK("EXIT, returning 0\n");
4463 * ata_host_set_remove - PCI layer callback for device removal
4464 * @host_set: ATA host set that was removed
4466 * Unregister all objects associated with this host set. Free those
4470 * Inherited from calling layer (may sleep).
4473 void ata_host_set_remove(struct ata_host_set *host_set)
4475 struct ata_port *ap;
4478 for (i = 0; i < host_set->n_ports; i++) {
4479 ap = host_set->ports[i];
4480 scsi_remove_host(ap->host);
4483 free_irq(host_set->irq, host_set);
4485 for (i = 0; i < host_set->n_ports; i++) {
4486 ap = host_set->ports[i];
4488 ata_scsi_release(ap->host);
4490 if ((ap->flags & ATA_FLAG_NO_LEGACY) == 0) {
4491 struct ata_ioports *ioaddr = &ap->ioaddr;
4493 if (ioaddr->cmd_addr == 0x1f0)
4494 release_region(0x1f0, 8);
4495 else if (ioaddr->cmd_addr == 0x170)
4496 release_region(0x170, 8);
4499 scsi_host_put(ap->host);
4502 if (host_set->ops->host_stop)
4503 host_set->ops->host_stop(host_set);
4509 * ata_scsi_release - SCSI layer callback hook for host unload
4510 * @host: libata host to be unloaded
4512 * Performs all duties necessary to shut down a libata port...
4513 * Kill port kthread, disable port, and release resources.
4516 * Inherited from SCSI layer.
4522 int ata_scsi_release(struct Scsi_Host *host)
4524 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
4528 ap->ops->port_disable(ap);
4529 ata_host_remove(ap, 0);
4536 * ata_std_ports - initialize ioaddr with standard port offsets.
4537 * @ioaddr: IO address structure to be initialized
4539 * Utility function which initializes data_addr, error_addr,
4540 * feature_addr, nsect_addr, lbal_addr, lbam_addr, lbah_addr,
4541 * device_addr, status_addr, and command_addr to standard offsets
4542 * relative to cmd_addr.
4544 * Does not set ctl_addr, altstatus_addr, bmdma_addr, or scr_addr.
4547 void ata_std_ports(struct ata_ioports *ioaddr)
4549 ioaddr->data_addr = ioaddr->cmd_addr + ATA_REG_DATA;
4550 ioaddr->error_addr = ioaddr->cmd_addr + ATA_REG_ERR;
4551 ioaddr->feature_addr = ioaddr->cmd_addr + ATA_REG_FEATURE;
4552 ioaddr->nsect_addr = ioaddr->cmd_addr + ATA_REG_NSECT;
4553 ioaddr->lbal_addr = ioaddr->cmd_addr + ATA_REG_LBAL;
4554 ioaddr->lbam_addr = ioaddr->cmd_addr + ATA_REG_LBAM;
4555 ioaddr->lbah_addr = ioaddr->cmd_addr + ATA_REG_LBAH;
4556 ioaddr->device_addr = ioaddr->cmd_addr + ATA_REG_DEVICE;
4557 ioaddr->status_addr = ioaddr->cmd_addr + ATA_REG_STATUS;
4558 ioaddr->command_addr = ioaddr->cmd_addr + ATA_REG_CMD;
4561 static struct ata_probe_ent *
4562 ata_probe_ent_alloc(struct device *dev, const struct ata_port_info *port)
4564 struct ata_probe_ent *probe_ent;
4566 probe_ent = kzalloc(sizeof(*probe_ent), GFP_KERNEL);
4568 printk(KERN_ERR DRV_NAME "(%s): out of memory\n",
4569 kobject_name(&(dev->kobj)));
4573 INIT_LIST_HEAD(&probe_ent->node);
4574 probe_ent->dev = dev;
4576 probe_ent->sht = port->sht;
4577 probe_ent->host_flags = port->host_flags;
4578 probe_ent->pio_mask = port->pio_mask;
4579 probe_ent->mwdma_mask = port->mwdma_mask;
4580 probe_ent->udma_mask = port->udma_mask;
4581 probe_ent->port_ops = port->port_ops;
4590 void ata_pci_host_stop (struct ata_host_set *host_set)
4592 struct pci_dev *pdev = to_pci_dev(host_set->dev);
4594 pci_iounmap(pdev, host_set->mmio_base);
4598 * ata_pci_init_native_mode - Initialize native-mode driver
4599 * @pdev: pci device to be initialized
4600 * @port: array[2] of pointers to port info structures.
4601 * @ports: bitmap of ports present
4603 * Utility function which allocates and initializes an
4604 * ata_probe_ent structure for a standard dual-port
4605 * PIO-based IDE controller. The returned ata_probe_ent
4606 * structure can be passed to ata_device_add(). The returned
4607 * ata_probe_ent structure should then be freed with kfree().
4609 * The caller need only pass the address of the primary port, the
4610 * secondary will be deduced automatically. If the device has non
4611 * standard secondary port mappings this function can be called twice,
4612 * once for each interface.
4615 struct ata_probe_ent *
4616 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int ports)
4618 struct ata_probe_ent *probe_ent =
4619 ata_probe_ent_alloc(pci_dev_to_dev(pdev), port[0]);
4625 probe_ent->irq = pdev->irq;
4626 probe_ent->irq_flags = SA_SHIRQ;
4627 probe_ent->private_data = port[0]->private_data;
4629 if (ports & ATA_PORT_PRIMARY) {
4630 probe_ent->port[p].cmd_addr = pci_resource_start(pdev, 0);
4631 probe_ent->port[p].altstatus_addr =
4632 probe_ent->port[p].ctl_addr =
4633 pci_resource_start(pdev, 1) | ATA_PCI_CTL_OFS;
4634 probe_ent->port[p].bmdma_addr = pci_resource_start(pdev, 4);
4635 ata_std_ports(&probe_ent->port[p]);
4639 if (ports & ATA_PORT_SECONDARY) {
4640 probe_ent->port[p].cmd_addr = pci_resource_start(pdev, 2);
4641 probe_ent->port[p].altstatus_addr =
4642 probe_ent->port[p].ctl_addr =
4643 pci_resource_start(pdev, 3) | ATA_PCI_CTL_OFS;
4644 probe_ent->port[p].bmdma_addr = pci_resource_start(pdev, 4) + 8;
4645 ata_std_ports(&probe_ent->port[p]);
4649 probe_ent->n_ports = p;
4653 static struct ata_probe_ent *ata_pci_init_legacy_port(struct pci_dev *pdev, struct ata_port_info *port, int port_num)
4655 struct ata_probe_ent *probe_ent;
4657 probe_ent = ata_probe_ent_alloc(pci_dev_to_dev(pdev), port);
4661 probe_ent->legacy_mode = 1;
4662 probe_ent->n_ports = 1;
4663 probe_ent->hard_port_no = port_num;
4664 probe_ent->private_data = port->private_data;
4669 probe_ent->irq = 14;
4670 probe_ent->port[0].cmd_addr = 0x1f0;
4671 probe_ent->port[0].altstatus_addr =
4672 probe_ent->port[0].ctl_addr = 0x3f6;
4675 probe_ent->irq = 15;
4676 probe_ent->port[0].cmd_addr = 0x170;
4677 probe_ent->port[0].altstatus_addr =
4678 probe_ent->port[0].ctl_addr = 0x376;
4681 probe_ent->port[0].bmdma_addr = pci_resource_start(pdev, 4) + 8 * port_num;
4682 ata_std_ports(&probe_ent->port[0]);
4687 * ata_pci_init_one - Initialize/register PCI IDE host controller
4688 * @pdev: Controller to be initialized
4689 * @port_info: Information from low-level host driver
4690 * @n_ports: Number of ports attached to host controller
4692 * This is a helper function which can be called from a driver's
4693 * xxx_init_one() probe function if the hardware uses traditional
4694 * IDE taskfile registers.
4696 * This function calls pci_enable_device(), reserves its register
4697 * regions, sets the dma mask, enables bus master mode, and calls
4701 * Inherited from PCI layer (may sleep).
4704 * Zero on success, negative on errno-based value on error.
4707 int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
4708 unsigned int n_ports)
4710 struct ata_probe_ent *probe_ent = NULL, *probe_ent2 = NULL;
4711 struct ata_port_info *port[2];
4713 unsigned int legacy_mode = 0;
4714 int disable_dev_on_err = 1;
4719 port[0] = port_info[0];
4721 port[1] = port_info[1];
4725 if ((port[0]->host_flags & ATA_FLAG_NO_LEGACY) == 0
4726 && (pdev->class >> 8) == PCI_CLASS_STORAGE_IDE) {
4727 /* TODO: What if one channel is in native mode ... */
4728 pci_read_config_byte(pdev, PCI_CLASS_PROG, &tmp8);
4729 mask = (1 << 2) | (1 << 0);
4730 if ((tmp8 & mask) != mask)
4731 legacy_mode = (1 << 3);
4735 if ((!legacy_mode) && (n_ports > 2)) {
4736 printk(KERN_ERR "ata: BUG: native mode, n_ports > 2\n");
4741 /* FIXME: Really for ATA it isn't safe because the device may be
4742 multi-purpose and we want to leave it alone if it was already
4743 enabled. Secondly for shared use as Arjan says we want refcounting
4745 Checking dev->is_enabled is insufficient as this is not set at
4746 boot for the primary video which is BIOS enabled
4749 rc = pci_enable_device(pdev);
4753 rc = pci_request_regions(pdev, DRV_NAME);
4755 disable_dev_on_err = 0;
4759 /* FIXME: Should use platform specific mappers for legacy port ranges */
4761 if (!request_region(0x1f0, 8, "libata")) {
4762 struct resource *conflict, res;
4764 res.end = 0x1f0 + 8 - 1;
4765 conflict = ____request_resource(&ioport_resource, &res);
4766 if (!strcmp(conflict->name, "libata"))
4767 legacy_mode |= (1 << 0);
4769 disable_dev_on_err = 0;
4770 printk(KERN_WARNING "ata: 0x1f0 IDE port busy\n");
4773 legacy_mode |= (1 << 0);
4775 if (!request_region(0x170, 8, "libata")) {
4776 struct resource *conflict, res;
4778 res.end = 0x170 + 8 - 1;
4779 conflict = ____request_resource(&ioport_resource, &res);
4780 if (!strcmp(conflict->name, "libata"))
4781 legacy_mode |= (1 << 1);
4783 disable_dev_on_err = 0;
4784 printk(KERN_WARNING "ata: 0x170 IDE port busy\n");
4787 legacy_mode |= (1 << 1);
4790 /* we have legacy mode, but all ports are unavailable */
4791 if (legacy_mode == (1 << 3)) {
4793 goto err_out_regions;
4796 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
4798 goto err_out_regions;
4799 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
4801 goto err_out_regions;
4804 if (legacy_mode & (1 << 0))
4805 probe_ent = ata_pci_init_legacy_port(pdev, port[0], 0);
4806 if (legacy_mode & (1 << 1))
4807 probe_ent2 = ata_pci_init_legacy_port(pdev, port[1], 1);
4810 probe_ent = ata_pci_init_native_mode(pdev, port, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
4812 probe_ent = ata_pci_init_native_mode(pdev, port, ATA_PORT_PRIMARY);
4814 if (!probe_ent && !probe_ent2) {
4816 goto err_out_regions;
4819 pci_set_master(pdev);
4821 /* FIXME: check ata_device_add return */
4823 if (legacy_mode & (1 << 0))
4824 ata_device_add(probe_ent);
4825 if (legacy_mode & (1 << 1))
4826 ata_device_add(probe_ent2);
4828 ata_device_add(probe_ent);
4836 if (legacy_mode & (1 << 0))
4837 release_region(0x1f0, 8);
4838 if (legacy_mode & (1 << 1))
4839 release_region(0x170, 8);
4840 pci_release_regions(pdev);
4842 if (disable_dev_on_err)
4843 pci_disable_device(pdev);
4848 * ata_pci_remove_one - PCI layer callback for device removal
4849 * @pdev: PCI device that was removed
4851 * PCI layer indicates to libata via this hook that
4852 * hot-unplug or module unload event has occurred.
4853 * Handle this by unregistering all objects associated
4854 * with this PCI device. Free those objects. Then finally
4855 * release PCI resources and disable device.
4858 * Inherited from PCI layer (may sleep).
4861 void ata_pci_remove_one (struct pci_dev *pdev)
4863 struct device *dev = pci_dev_to_dev(pdev);
4864 struct ata_host_set *host_set = dev_get_drvdata(dev);
4866 ata_host_set_remove(host_set);
4867 pci_release_regions(pdev);
4868 pci_disable_device(pdev);
4869 dev_set_drvdata(dev, NULL);
4872 /* move to PCI subsystem */
4873 int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits)
4875 unsigned long tmp = 0;
4877 switch (bits->width) {
4880 pci_read_config_byte(pdev, bits->reg, &tmp8);
4886 pci_read_config_word(pdev, bits->reg, &tmp16);
4892 pci_read_config_dword(pdev, bits->reg, &tmp32);
4903 return (tmp == bits->val) ? 1 : 0;
4905 #endif /* CONFIG_PCI */
4908 static int __init ata_init(void)
4910 ata_wq = create_workqueue("ata");
4914 printk(KERN_DEBUG "libata version " DRV_VERSION " loaded.\n");
4918 static void __exit ata_exit(void)
4920 destroy_workqueue(ata_wq);
4923 module_init(ata_init);
4924 module_exit(ata_exit);
4926 static unsigned long ratelimit_time;
4927 static spinlock_t ata_ratelimit_lock = SPIN_LOCK_UNLOCKED;
4929 int ata_ratelimit(void)
4932 unsigned long flags;
4934 spin_lock_irqsave(&ata_ratelimit_lock, flags);
4936 if (time_after(jiffies, ratelimit_time)) {
4938 ratelimit_time = jiffies + (HZ/5);
4942 spin_unlock_irqrestore(&ata_ratelimit_lock, flags);
4948 * libata is essentially a library of internal helper functions for
4949 * low-level ATA host controller drivers. As such, the API/ABI is
4950 * likely to change as new drivers are added and updated.
4951 * Do not depend on ABI/API stability.
4954 EXPORT_SYMBOL_GPL(ata_std_bios_param);
4955 EXPORT_SYMBOL_GPL(ata_std_ports);
4956 EXPORT_SYMBOL_GPL(ata_device_add);
4957 EXPORT_SYMBOL_GPL(ata_host_set_remove);
4958 EXPORT_SYMBOL_GPL(ata_sg_init);
4959 EXPORT_SYMBOL_GPL(ata_sg_init_one);
4960 EXPORT_SYMBOL_GPL(ata_qc_complete);
4961 EXPORT_SYMBOL_GPL(ata_qc_issue_prot);
4962 EXPORT_SYMBOL_GPL(ata_eng_timeout);
4963 EXPORT_SYMBOL_GPL(ata_tf_load);
4964 EXPORT_SYMBOL_GPL(ata_tf_read);
4965 EXPORT_SYMBOL_GPL(ata_noop_dev_select);
4966 EXPORT_SYMBOL_GPL(ata_std_dev_select);
4967 EXPORT_SYMBOL_GPL(ata_tf_to_fis);
4968 EXPORT_SYMBOL_GPL(ata_tf_from_fis);
4969 EXPORT_SYMBOL_GPL(ata_check_status);
4970 EXPORT_SYMBOL_GPL(ata_altstatus);
4971 EXPORT_SYMBOL_GPL(ata_exec_command);
4972 EXPORT_SYMBOL_GPL(ata_port_start);
4973 EXPORT_SYMBOL_GPL(ata_port_stop);
4974 EXPORT_SYMBOL_GPL(ata_host_stop);
4975 EXPORT_SYMBOL_GPL(ata_interrupt);
4976 EXPORT_SYMBOL_GPL(ata_qc_prep);
4977 EXPORT_SYMBOL_GPL(ata_bmdma_setup);
4978 EXPORT_SYMBOL_GPL(ata_bmdma_start);
4979 EXPORT_SYMBOL_GPL(ata_bmdma_irq_clear);
4980 EXPORT_SYMBOL_GPL(ata_bmdma_status);
4981 EXPORT_SYMBOL_GPL(ata_bmdma_stop);
4982 EXPORT_SYMBOL_GPL(ata_port_probe);
4983 EXPORT_SYMBOL_GPL(sata_phy_reset);
4984 EXPORT_SYMBOL_GPL(__sata_phy_reset);
4985 EXPORT_SYMBOL_GPL(ata_bus_reset);
4986 EXPORT_SYMBOL_GPL(ata_port_disable);
4987 EXPORT_SYMBOL_GPL(ata_ratelimit);
4988 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
4989 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
4990 EXPORT_SYMBOL_GPL(ata_scsi_error);
4991 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
4992 EXPORT_SYMBOL_GPL(ata_scsi_release);
4993 EXPORT_SYMBOL_GPL(ata_host_intr);
4994 EXPORT_SYMBOL_GPL(ata_dev_classify);
4995 EXPORT_SYMBOL_GPL(ata_dev_id_string);
4996 EXPORT_SYMBOL_GPL(ata_dev_config);
4997 EXPORT_SYMBOL_GPL(ata_scsi_simulate);
4999 EXPORT_SYMBOL_GPL(ata_timing_compute);
5000 EXPORT_SYMBOL_GPL(ata_timing_merge);
5003 EXPORT_SYMBOL_GPL(pci_test_config_bits);
5004 EXPORT_SYMBOL_GPL(ata_pci_host_stop);
5005 EXPORT_SYMBOL_GPL(ata_pci_init_native_mode);
5006 EXPORT_SYMBOL_GPL(ata_pci_init_one);
5007 EXPORT_SYMBOL_GPL(ata_pci_remove_one);
5008 #endif /* CONFIG_PCI */