[PATCH] libata: use local *id instead of dev->id in ata_dev_configure()
[linux-2.6/s3c2410-cpufreq.git] / drivers / scsi / libata-core.c
blob6fe41fb03929b6a355adf4775048f6d55120e519
1 /*
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
6 * on emails.
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)
15 * any later version.
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>
41 #include <linux/mm.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>
58 #include <asm/io.h>
59 #include <asm/semaphore.h>
60 #include <asm/byteorder.h>
62 #include "libata.h"
64 static unsigned int ata_dev_init_params(struct ata_port *ap,
65 struct ata_device *dev);
66 static void ata_set_mode(struct ata_port *ap);
67 static void ata_dev_set_xfermode(struct ata_port *ap, struct ata_device *dev);
68 static unsigned int ata_dev_xfermask(struct ata_port *ap,
69 struct ata_device *dev);
71 static unsigned int ata_unique_id = 1;
72 static struct workqueue_struct *ata_wq;
74 int atapi_enabled = 1;
75 module_param(atapi_enabled, int, 0444);
76 MODULE_PARM_DESC(atapi_enabled, "Enable discovery of ATAPI devices (0=off, 1=on)");
78 int libata_fua = 0;
79 module_param_named(fua, libata_fua, int, 0444);
80 MODULE_PARM_DESC(fua, "FUA support (0=off, 1=on)");
82 MODULE_AUTHOR("Jeff Garzik");
83 MODULE_DESCRIPTION("Library module for ATA devices");
84 MODULE_LICENSE("GPL");
85 MODULE_VERSION(DRV_VERSION);
88 /**
89 * ata_tf_to_fis - Convert ATA taskfile to SATA FIS structure
90 * @tf: Taskfile to convert
91 * @fis: Buffer into which data will output
92 * @pmp: Port multiplier port
94 * Converts a standard ATA taskfile to a Serial ATA
95 * FIS structure (Register - Host to Device).
97 * LOCKING:
98 * Inherited from caller.
101 void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp)
103 fis[0] = 0x27; /* Register - Host to Device FIS */
104 fis[1] = (pmp & 0xf) | (1 << 7); /* Port multiplier number,
105 bit 7 indicates Command FIS */
106 fis[2] = tf->command;
107 fis[3] = tf->feature;
109 fis[4] = tf->lbal;
110 fis[5] = tf->lbam;
111 fis[6] = tf->lbah;
112 fis[7] = tf->device;
114 fis[8] = tf->hob_lbal;
115 fis[9] = tf->hob_lbam;
116 fis[10] = tf->hob_lbah;
117 fis[11] = tf->hob_feature;
119 fis[12] = tf->nsect;
120 fis[13] = tf->hob_nsect;
121 fis[14] = 0;
122 fis[15] = tf->ctl;
124 fis[16] = 0;
125 fis[17] = 0;
126 fis[18] = 0;
127 fis[19] = 0;
131 * ata_tf_from_fis - Convert SATA FIS to ATA taskfile
132 * @fis: Buffer from which data will be input
133 * @tf: Taskfile to output
135 * Converts a serial ATA FIS structure to a standard ATA taskfile.
137 * LOCKING:
138 * Inherited from caller.
141 void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf)
143 tf->command = fis[2]; /* status */
144 tf->feature = fis[3]; /* error */
146 tf->lbal = fis[4];
147 tf->lbam = fis[5];
148 tf->lbah = fis[6];
149 tf->device = fis[7];
151 tf->hob_lbal = fis[8];
152 tf->hob_lbam = fis[9];
153 tf->hob_lbah = fis[10];
155 tf->nsect = fis[12];
156 tf->hob_nsect = fis[13];
159 static const u8 ata_rw_cmds[] = {
160 /* pio multi */
161 ATA_CMD_READ_MULTI,
162 ATA_CMD_WRITE_MULTI,
163 ATA_CMD_READ_MULTI_EXT,
164 ATA_CMD_WRITE_MULTI_EXT,
168 ATA_CMD_WRITE_MULTI_FUA_EXT,
169 /* pio */
170 ATA_CMD_PIO_READ,
171 ATA_CMD_PIO_WRITE,
172 ATA_CMD_PIO_READ_EXT,
173 ATA_CMD_PIO_WRITE_EXT,
178 /* dma */
179 ATA_CMD_READ,
180 ATA_CMD_WRITE,
181 ATA_CMD_READ_EXT,
182 ATA_CMD_WRITE_EXT,
186 ATA_CMD_WRITE_FUA_EXT
190 * ata_rwcmd_protocol - set taskfile r/w commands and protocol
191 * @qc: command to examine and configure
193 * Examine the device configuration and tf->flags to calculate
194 * the proper read/write commands and protocol to use.
196 * LOCKING:
197 * caller.
199 int ata_rwcmd_protocol(struct ata_queued_cmd *qc)
201 struct ata_taskfile *tf = &qc->tf;
202 struct ata_device *dev = qc->dev;
203 u8 cmd;
205 int index, fua, lba48, write;
207 fua = (tf->flags & ATA_TFLAG_FUA) ? 4 : 0;
208 lba48 = (tf->flags & ATA_TFLAG_LBA48) ? 2 : 0;
209 write = (tf->flags & ATA_TFLAG_WRITE) ? 1 : 0;
211 if (dev->flags & ATA_DFLAG_PIO) {
212 tf->protocol = ATA_PROT_PIO;
213 index = dev->multi_count ? 0 : 8;
214 } else if (lba48 && (qc->ap->flags & ATA_FLAG_PIO_LBA48)) {
215 /* Unable to use DMA due to host limitation */
216 tf->protocol = ATA_PROT_PIO;
217 index = dev->multi_count ? 0 : 8;
218 } else {
219 tf->protocol = ATA_PROT_DMA;
220 index = 16;
223 cmd = ata_rw_cmds[index + fua + lba48 + write];
224 if (cmd) {
225 tf->command = cmd;
226 return 0;
228 return -1;
232 * ata_pack_xfermask - Pack pio, mwdma and udma masks into xfer_mask
233 * @pio_mask: pio_mask
234 * @mwdma_mask: mwdma_mask
235 * @udma_mask: udma_mask
237 * Pack @pio_mask, @mwdma_mask and @udma_mask into a single
238 * unsigned int xfer_mask.
240 * LOCKING:
241 * None.
243 * RETURNS:
244 * Packed xfer_mask.
246 static unsigned int ata_pack_xfermask(unsigned int pio_mask,
247 unsigned int mwdma_mask,
248 unsigned int udma_mask)
250 return ((pio_mask << ATA_SHIFT_PIO) & ATA_MASK_PIO) |
251 ((mwdma_mask << ATA_SHIFT_MWDMA) & ATA_MASK_MWDMA) |
252 ((udma_mask << ATA_SHIFT_UDMA) & ATA_MASK_UDMA);
255 static const struct ata_xfer_ent {
256 unsigned int shift, bits;
257 u8 base;
258 } ata_xfer_tbl[] = {
259 { ATA_SHIFT_PIO, ATA_BITS_PIO, XFER_PIO_0 },
260 { ATA_SHIFT_MWDMA, ATA_BITS_MWDMA, XFER_MW_DMA_0 },
261 { ATA_SHIFT_UDMA, ATA_BITS_UDMA, XFER_UDMA_0 },
262 { -1, },
266 * ata_xfer_mask2mode - Find matching XFER_* for the given xfer_mask
267 * @xfer_mask: xfer_mask of interest
269 * Return matching XFER_* value for @xfer_mask. Only the highest
270 * bit of @xfer_mask is considered.
272 * LOCKING:
273 * None.
275 * RETURNS:
276 * Matching XFER_* value, 0 if no match found.
278 static u8 ata_xfer_mask2mode(unsigned int xfer_mask)
280 int highbit = fls(xfer_mask) - 1;
281 const struct ata_xfer_ent *ent;
283 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
284 if (highbit >= ent->shift && highbit < ent->shift + ent->bits)
285 return ent->base + highbit - ent->shift;
286 return 0;
290 * ata_xfer_mode2mask - Find matching xfer_mask for XFER_*
291 * @xfer_mode: XFER_* of interest
293 * Return matching xfer_mask for @xfer_mode.
295 * LOCKING:
296 * None.
298 * RETURNS:
299 * Matching xfer_mask, 0 if no match found.
301 static unsigned int ata_xfer_mode2mask(u8 xfer_mode)
303 const struct ata_xfer_ent *ent;
305 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
306 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
307 return 1 << (ent->shift + xfer_mode - ent->base);
308 return 0;
312 * ata_xfer_mode2shift - Find matching xfer_shift for XFER_*
313 * @xfer_mode: XFER_* of interest
315 * Return matching xfer_shift for @xfer_mode.
317 * LOCKING:
318 * None.
320 * RETURNS:
321 * Matching xfer_shift, -1 if no match found.
323 static int ata_xfer_mode2shift(unsigned int xfer_mode)
325 const struct ata_xfer_ent *ent;
327 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
328 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
329 return ent->shift;
330 return -1;
334 * ata_mode_string - convert xfer_mask to string
335 * @xfer_mask: mask of bits supported; only highest bit counts.
337 * Determine string which represents the highest speed
338 * (highest bit in @modemask).
340 * LOCKING:
341 * None.
343 * RETURNS:
344 * Constant C string representing highest speed listed in
345 * @mode_mask, or the constant C string "<n/a>".
347 static const char *ata_mode_string(unsigned int xfer_mask)
349 static const char * const xfer_mode_str[] = {
350 "PIO0",
351 "PIO1",
352 "PIO2",
353 "PIO3",
354 "PIO4",
355 "MWDMA0",
356 "MWDMA1",
357 "MWDMA2",
358 "UDMA/16",
359 "UDMA/25",
360 "UDMA/33",
361 "UDMA/44",
362 "UDMA/66",
363 "UDMA/100",
364 "UDMA/133",
365 "UDMA7",
367 int highbit;
369 highbit = fls(xfer_mask) - 1;
370 if (highbit >= 0 && highbit < ARRAY_SIZE(xfer_mode_str))
371 return xfer_mode_str[highbit];
372 return "<n/a>";
376 * ata_pio_devchk - PATA device presence detection
377 * @ap: ATA channel to examine
378 * @device: Device to examine (starting at zero)
380 * This technique was originally described in
381 * Hale Landis's ATADRVR (www.ata-atapi.com), and
382 * later found its way into the ATA/ATAPI spec.
384 * Write a pattern to the ATA shadow registers,
385 * and if a device is present, it will respond by
386 * correctly storing and echoing back the
387 * ATA shadow register contents.
389 * LOCKING:
390 * caller.
393 static unsigned int ata_pio_devchk(struct ata_port *ap,
394 unsigned int device)
396 struct ata_ioports *ioaddr = &ap->ioaddr;
397 u8 nsect, lbal;
399 ap->ops->dev_select(ap, device);
401 outb(0x55, ioaddr->nsect_addr);
402 outb(0xaa, ioaddr->lbal_addr);
404 outb(0xaa, ioaddr->nsect_addr);
405 outb(0x55, ioaddr->lbal_addr);
407 outb(0x55, ioaddr->nsect_addr);
408 outb(0xaa, ioaddr->lbal_addr);
410 nsect = inb(ioaddr->nsect_addr);
411 lbal = inb(ioaddr->lbal_addr);
413 if ((nsect == 0x55) && (lbal == 0xaa))
414 return 1; /* we found a device */
416 return 0; /* nothing found */
420 * ata_mmio_devchk - PATA device presence detection
421 * @ap: ATA channel to examine
422 * @device: Device to examine (starting at zero)
424 * This technique was originally described in
425 * Hale Landis's ATADRVR (www.ata-atapi.com), and
426 * later found its way into the ATA/ATAPI spec.
428 * Write a pattern to the ATA shadow registers,
429 * and if a device is present, it will respond by
430 * correctly storing and echoing back the
431 * ATA shadow register contents.
433 * LOCKING:
434 * caller.
437 static unsigned int ata_mmio_devchk(struct ata_port *ap,
438 unsigned int device)
440 struct ata_ioports *ioaddr = &ap->ioaddr;
441 u8 nsect, lbal;
443 ap->ops->dev_select(ap, device);
445 writeb(0x55, (void __iomem *) ioaddr->nsect_addr);
446 writeb(0xaa, (void __iomem *) ioaddr->lbal_addr);
448 writeb(0xaa, (void __iomem *) ioaddr->nsect_addr);
449 writeb(0x55, (void __iomem *) ioaddr->lbal_addr);
451 writeb(0x55, (void __iomem *) ioaddr->nsect_addr);
452 writeb(0xaa, (void __iomem *) ioaddr->lbal_addr);
454 nsect = readb((void __iomem *) ioaddr->nsect_addr);
455 lbal = readb((void __iomem *) ioaddr->lbal_addr);
457 if ((nsect == 0x55) && (lbal == 0xaa))
458 return 1; /* we found a device */
460 return 0; /* nothing found */
464 * ata_devchk - PATA device presence detection
465 * @ap: ATA channel to examine
466 * @device: Device to examine (starting at zero)
468 * Dispatch ATA device presence detection, depending
469 * on whether we are using PIO or MMIO to talk to the
470 * ATA shadow registers.
472 * LOCKING:
473 * caller.
476 static unsigned int ata_devchk(struct ata_port *ap,
477 unsigned int device)
479 if (ap->flags & ATA_FLAG_MMIO)
480 return ata_mmio_devchk(ap, device);
481 return ata_pio_devchk(ap, device);
485 * ata_dev_classify - determine device type based on ATA-spec signature
486 * @tf: ATA taskfile register set for device to be identified
488 * Determine from taskfile register contents whether a device is
489 * ATA or ATAPI, as per "Signature and persistence" section
490 * of ATA/PI spec (volume 1, sect 5.14).
492 * LOCKING:
493 * None.
495 * RETURNS:
496 * Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, or %ATA_DEV_UNKNOWN
497 * the event of failure.
500 unsigned int ata_dev_classify(const struct ata_taskfile *tf)
502 /* Apple's open source Darwin code hints that some devices only
503 * put a proper signature into the LBA mid/high registers,
504 * So, we only check those. It's sufficient for uniqueness.
507 if (((tf->lbam == 0) && (tf->lbah == 0)) ||
508 ((tf->lbam == 0x3c) && (tf->lbah == 0xc3))) {
509 DPRINTK("found ATA device by sig\n");
510 return ATA_DEV_ATA;
513 if (((tf->lbam == 0x14) && (tf->lbah == 0xeb)) ||
514 ((tf->lbam == 0x69) && (tf->lbah == 0x96))) {
515 DPRINTK("found ATAPI device by sig\n");
516 return ATA_DEV_ATAPI;
519 DPRINTK("unknown device\n");
520 return ATA_DEV_UNKNOWN;
524 * ata_dev_try_classify - Parse returned ATA device signature
525 * @ap: ATA channel to examine
526 * @device: Device to examine (starting at zero)
527 * @r_err: Value of error register on completion
529 * After an event -- SRST, E.D.D., or SATA COMRESET -- occurs,
530 * an ATA/ATAPI-defined set of values is placed in the ATA
531 * shadow registers, indicating the results of device detection
532 * and diagnostics.
534 * Select the ATA device, and read the values from the ATA shadow
535 * registers. Then parse according to the Error register value,
536 * and the spec-defined values examined by ata_dev_classify().
538 * LOCKING:
539 * caller.
541 * RETURNS:
542 * Device type - %ATA_DEV_ATA, %ATA_DEV_ATAPI or %ATA_DEV_NONE.
545 static unsigned int
546 ata_dev_try_classify(struct ata_port *ap, unsigned int device, u8 *r_err)
548 struct ata_taskfile tf;
549 unsigned int class;
550 u8 err;
552 ap->ops->dev_select(ap, device);
554 memset(&tf, 0, sizeof(tf));
556 ap->ops->tf_read(ap, &tf);
557 err = tf.feature;
558 if (r_err)
559 *r_err = err;
561 /* see if device passed diags */
562 if (err == 1)
563 /* do nothing */ ;
564 else if ((device == 0) && (err == 0x81))
565 /* do nothing */ ;
566 else
567 return ATA_DEV_NONE;
569 /* determine if device is ATA or ATAPI */
570 class = ata_dev_classify(&tf);
572 if (class == ATA_DEV_UNKNOWN)
573 return ATA_DEV_NONE;
574 if ((class == ATA_DEV_ATA) && (ata_chk_status(ap) == 0))
575 return ATA_DEV_NONE;
576 return class;
580 * ata_id_string - Convert IDENTIFY DEVICE page into string
581 * @id: IDENTIFY DEVICE results we will examine
582 * @s: string into which data is output
583 * @ofs: offset into identify device page
584 * @len: length of string to return. must be an even number.
586 * The strings in the IDENTIFY DEVICE page are broken up into
587 * 16-bit chunks. Run through the string, and output each
588 * 8-bit chunk linearly, regardless of platform.
590 * LOCKING:
591 * caller.
594 void ata_id_string(const u16 *id, unsigned char *s,
595 unsigned int ofs, unsigned int len)
597 unsigned int c;
599 while (len > 0) {
600 c = id[ofs] >> 8;
601 *s = c;
602 s++;
604 c = id[ofs] & 0xff;
605 *s = c;
606 s++;
608 ofs++;
609 len -= 2;
614 * ata_id_c_string - Convert IDENTIFY DEVICE page into C string
615 * @id: IDENTIFY DEVICE results we will examine
616 * @s: string into which data is output
617 * @ofs: offset into identify device page
618 * @len: length of string to return. must be an odd number.
620 * This function is identical to ata_id_string except that it
621 * trims trailing spaces and terminates the resulting string with
622 * null. @len must be actual maximum length (even number) + 1.
624 * LOCKING:
625 * caller.
627 void ata_id_c_string(const u16 *id, unsigned char *s,
628 unsigned int ofs, unsigned int len)
630 unsigned char *p;
632 WARN_ON(!(len & 1));
634 ata_id_string(id, s, ofs, len - 1);
636 p = s + strnlen(s, len - 1);
637 while (p > s && p[-1] == ' ')
638 p--;
639 *p = '\0';
642 static u64 ata_id_n_sectors(const u16 *id)
644 if (ata_id_has_lba(id)) {
645 if (ata_id_has_lba48(id))
646 return ata_id_u64(id, 100);
647 else
648 return ata_id_u32(id, 60);
649 } else {
650 if (ata_id_current_chs_valid(id))
651 return ata_id_u32(id, 57);
652 else
653 return id[1] * id[3] * id[6];
658 * ata_noop_dev_select - Select device 0/1 on ATA bus
659 * @ap: ATA channel to manipulate
660 * @device: ATA device (numbered from zero) to select
662 * This function performs no actual function.
664 * May be used as the dev_select() entry in ata_port_operations.
666 * LOCKING:
667 * caller.
669 void ata_noop_dev_select (struct ata_port *ap, unsigned int device)
675 * ata_std_dev_select - Select device 0/1 on ATA bus
676 * @ap: ATA channel to manipulate
677 * @device: ATA device (numbered from zero) to select
679 * Use the method defined in the ATA specification to
680 * make either device 0, or device 1, active on the
681 * ATA channel. Works with both PIO and MMIO.
683 * May be used as the dev_select() entry in ata_port_operations.
685 * LOCKING:
686 * caller.
689 void ata_std_dev_select (struct ata_port *ap, unsigned int device)
691 u8 tmp;
693 if (device == 0)
694 tmp = ATA_DEVICE_OBS;
695 else
696 tmp = ATA_DEVICE_OBS | ATA_DEV1;
698 if (ap->flags & ATA_FLAG_MMIO) {
699 writeb(tmp, (void __iomem *) ap->ioaddr.device_addr);
700 } else {
701 outb(tmp, ap->ioaddr.device_addr);
703 ata_pause(ap); /* needed; also flushes, for mmio */
707 * ata_dev_select - Select device 0/1 on ATA bus
708 * @ap: ATA channel to manipulate
709 * @device: ATA device (numbered from zero) to select
710 * @wait: non-zero to wait for Status register BSY bit to clear
711 * @can_sleep: non-zero if context allows sleeping
713 * Use the method defined in the ATA specification to
714 * make either device 0, or device 1, active on the
715 * ATA channel.
717 * This is a high-level version of ata_std_dev_select(),
718 * which additionally provides the services of inserting
719 * the proper pauses and status polling, where needed.
721 * LOCKING:
722 * caller.
725 void ata_dev_select(struct ata_port *ap, unsigned int device,
726 unsigned int wait, unsigned int can_sleep)
728 VPRINTK("ENTER, ata%u: device %u, wait %u\n",
729 ap->id, device, wait);
731 if (wait)
732 ata_wait_idle(ap);
734 ap->ops->dev_select(ap, device);
736 if (wait) {
737 if (can_sleep && ap->device[device].class == ATA_DEV_ATAPI)
738 msleep(150);
739 ata_wait_idle(ap);
744 * ata_dump_id - IDENTIFY DEVICE info debugging output
745 * @id: IDENTIFY DEVICE page to dump
747 * Dump selected 16-bit words from the given IDENTIFY DEVICE
748 * page.
750 * LOCKING:
751 * caller.
754 static inline void ata_dump_id(const u16 *id)
756 DPRINTK("49==0x%04x "
757 "53==0x%04x "
758 "63==0x%04x "
759 "64==0x%04x "
760 "75==0x%04x \n",
761 id[49],
762 id[53],
763 id[63],
764 id[64],
765 id[75]);
766 DPRINTK("80==0x%04x "
767 "81==0x%04x "
768 "82==0x%04x "
769 "83==0x%04x "
770 "84==0x%04x \n",
771 id[80],
772 id[81],
773 id[82],
774 id[83],
775 id[84]);
776 DPRINTK("88==0x%04x "
777 "93==0x%04x\n",
778 id[88],
779 id[93]);
783 * ata_id_xfermask - Compute xfermask from the given IDENTIFY data
784 * @id: IDENTIFY data to compute xfer mask from
786 * Compute the xfermask for this device. This is not as trivial
787 * as it seems if we must consider early devices correctly.
789 * FIXME: pre IDE drive timing (do we care ?).
791 * LOCKING:
792 * None.
794 * RETURNS:
795 * Computed xfermask
797 static unsigned int ata_id_xfermask(const u16 *id)
799 unsigned int pio_mask, mwdma_mask, udma_mask;
801 /* Usual case. Word 53 indicates word 64 is valid */
802 if (id[ATA_ID_FIELD_VALID] & (1 << 1)) {
803 pio_mask = id[ATA_ID_PIO_MODES] & 0x03;
804 pio_mask <<= 3;
805 pio_mask |= 0x7;
806 } else {
807 /* If word 64 isn't valid then Word 51 high byte holds
808 * the PIO timing number for the maximum. Turn it into
809 * a mask.
811 pio_mask = (2 << (id[ATA_ID_OLD_PIO_MODES] & 0xFF)) - 1 ;
813 /* But wait.. there's more. Design your standards by
814 * committee and you too can get a free iordy field to
815 * process. However its the speeds not the modes that
816 * are supported... Note drivers using the timing API
817 * will get this right anyway
821 mwdma_mask = id[ATA_ID_MWDMA_MODES] & 0x07;
823 udma_mask = 0;
824 if (id[ATA_ID_FIELD_VALID] & (1 << 2))
825 udma_mask = id[ATA_ID_UDMA_MODES] & 0xff;
827 return ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
831 * ata_port_queue_task - Queue port_task
832 * @ap: The ata_port to queue port_task for
834 * Schedule @fn(@data) for execution after @delay jiffies using
835 * port_task. There is one port_task per port and it's the
836 * user(low level driver)'s responsibility to make sure that only
837 * one task is active at any given time.
839 * libata core layer takes care of synchronization between
840 * port_task and EH. ata_port_queue_task() may be ignored for EH
841 * synchronization.
843 * LOCKING:
844 * Inherited from caller.
846 void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *), void *data,
847 unsigned long delay)
849 int rc;
851 if (ap->flags & ATA_FLAG_FLUSH_PORT_TASK)
852 return;
854 PREPARE_WORK(&ap->port_task, fn, data);
856 if (!delay)
857 rc = queue_work(ata_wq, &ap->port_task);
858 else
859 rc = queue_delayed_work(ata_wq, &ap->port_task, delay);
861 /* rc == 0 means that another user is using port task */
862 WARN_ON(rc == 0);
866 * ata_port_flush_task - Flush port_task
867 * @ap: The ata_port to flush port_task for
869 * After this function completes, port_task is guranteed not to
870 * be running or scheduled.
872 * LOCKING:
873 * Kernel thread context (may sleep)
875 void ata_port_flush_task(struct ata_port *ap)
877 unsigned long flags;
879 DPRINTK("ENTER\n");
881 spin_lock_irqsave(&ap->host_set->lock, flags);
882 ap->flags |= ATA_FLAG_FLUSH_PORT_TASK;
883 spin_unlock_irqrestore(&ap->host_set->lock, flags);
885 DPRINTK("flush #1\n");
886 flush_workqueue(ata_wq);
889 * At this point, if a task is running, it's guaranteed to see
890 * the FLUSH flag; thus, it will never queue pio tasks again.
891 * Cancel and flush.
893 if (!cancel_delayed_work(&ap->port_task)) {
894 DPRINTK("flush #2\n");
895 flush_workqueue(ata_wq);
898 spin_lock_irqsave(&ap->host_set->lock, flags);
899 ap->flags &= ~ATA_FLAG_FLUSH_PORT_TASK;
900 spin_unlock_irqrestore(&ap->host_set->lock, flags);
902 DPRINTK("EXIT\n");
905 void ata_qc_complete_internal(struct ata_queued_cmd *qc)
907 struct completion *waiting = qc->private_data;
909 qc->ap->ops->tf_read(qc->ap, &qc->tf);
910 complete(waiting);
914 * ata_exec_internal - execute libata internal command
915 * @ap: Port to which the command is sent
916 * @dev: Device to which the command is sent
917 * @tf: Taskfile registers for the command and the result
918 * @dma_dir: Data tranfer direction of the command
919 * @buf: Data buffer of the command
920 * @buflen: Length of data buffer
922 * Executes libata internal command with timeout. @tf contains
923 * command on entry and result on return. Timeout and error
924 * conditions are reported via return value. No recovery action
925 * is taken after a command times out. It's caller's duty to
926 * clean up after timeout.
928 * LOCKING:
929 * None. Should be called with kernel context, might sleep.
932 static unsigned
933 ata_exec_internal(struct ata_port *ap, struct ata_device *dev,
934 struct ata_taskfile *tf,
935 int dma_dir, void *buf, unsigned int buflen)
937 u8 command = tf->command;
938 struct ata_queued_cmd *qc;
939 DECLARE_COMPLETION(wait);
940 unsigned long flags;
941 unsigned int err_mask;
943 spin_lock_irqsave(&ap->host_set->lock, flags);
945 qc = ata_qc_new_init(ap, dev);
946 BUG_ON(qc == NULL);
948 qc->tf = *tf;
949 qc->dma_dir = dma_dir;
950 if (dma_dir != DMA_NONE) {
951 ata_sg_init_one(qc, buf, buflen);
952 qc->nsect = buflen / ATA_SECT_SIZE;
955 qc->private_data = &wait;
956 qc->complete_fn = ata_qc_complete_internal;
958 qc->err_mask = ata_qc_issue(qc);
959 if (qc->err_mask)
960 ata_qc_complete(qc);
962 spin_unlock_irqrestore(&ap->host_set->lock, flags);
964 if (!wait_for_completion_timeout(&wait, ATA_TMOUT_INTERNAL)) {
965 spin_lock_irqsave(&ap->host_set->lock, flags);
967 /* We're racing with irq here. If we lose, the
968 * following test prevents us from completing the qc
969 * again. If completion irq occurs after here but
970 * before the caller cleans up, it will result in a
971 * spurious interrupt. We can live with that.
973 if (qc->flags & ATA_QCFLAG_ACTIVE) {
974 qc->err_mask = AC_ERR_TIMEOUT;
975 ata_qc_complete(qc);
976 printk(KERN_WARNING "ata%u: qc timeout (cmd 0x%x)\n",
977 ap->id, command);
980 spin_unlock_irqrestore(&ap->host_set->lock, flags);
983 *tf = qc->tf;
984 err_mask = qc->err_mask;
986 ata_qc_free(qc);
988 return err_mask;
992 * ata_pio_need_iordy - check if iordy needed
993 * @adev: ATA device
995 * Check if the current speed of the device requires IORDY. Used
996 * by various controllers for chip configuration.
999 unsigned int ata_pio_need_iordy(const struct ata_device *adev)
1001 int pio;
1002 int speed = adev->pio_mode - XFER_PIO_0;
1004 if (speed < 2)
1005 return 0;
1006 if (speed > 2)
1007 return 1;
1009 /* If we have no drive specific rule, then PIO 2 is non IORDY */
1011 if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE */
1012 pio = adev->id[ATA_ID_EIDE_PIO];
1013 /* Is the speed faster than the drive allows non IORDY ? */
1014 if (pio) {
1015 /* This is cycle times not frequency - watch the logic! */
1016 if (pio > 240) /* PIO2 is 240nS per cycle */
1017 return 1;
1018 return 0;
1021 return 0;
1025 * ata_dev_read_id - Read ID data from the specified device
1026 * @ap: port on which target device resides
1027 * @dev: target device
1028 * @p_class: pointer to class of the target device (may be changed)
1029 * @post_reset: is this read ID post-reset?
1030 * @p_id: read IDENTIFY page (newly allocated)
1032 * Read ID data from the specified device. ATA_CMD_ID_ATA is
1033 * performed on ATA devices and ATA_CMD_ID_ATAPI on ATAPI
1034 * devices. This function also takes care of EDD signature
1035 * misreporting (to be removed once EDD support is gone) and
1036 * issues ATA_CMD_INIT_DEV_PARAMS for pre-ATA4 drives.
1038 * LOCKING:
1039 * Kernel thread context (may sleep)
1041 * RETURNS:
1042 * 0 on success, -errno otherwise.
1044 static int ata_dev_read_id(struct ata_port *ap, struct ata_device *dev,
1045 unsigned int *p_class, int post_reset, u16 **p_id)
1047 unsigned int class = *p_class;
1048 unsigned int using_edd;
1049 struct ata_taskfile tf;
1050 unsigned int err_mask = 0;
1051 u16 *id;
1052 const char *reason;
1053 int rc;
1055 DPRINTK("ENTER, host %u, dev %u\n", ap->id, dev->devno);
1057 if (ap->ops->probe_reset ||
1058 ap->flags & (ATA_FLAG_SRST | ATA_FLAG_SATA_RESET))
1059 using_edd = 0;
1060 else
1061 using_edd = 1;
1063 ata_dev_select(ap, dev->devno, 1, 1); /* select device 0/1 */
1065 id = kmalloc(sizeof(id[0]) * ATA_ID_WORDS, GFP_KERNEL);
1066 if (id == NULL) {
1067 rc = -ENOMEM;
1068 reason = "out of memory";
1069 goto err_out;
1072 retry:
1073 ata_tf_init(ap, &tf, dev->devno);
1075 switch (class) {
1076 case ATA_DEV_ATA:
1077 tf.command = ATA_CMD_ID_ATA;
1078 break;
1079 case ATA_DEV_ATAPI:
1080 tf.command = ATA_CMD_ID_ATAPI;
1081 break;
1082 default:
1083 rc = -ENODEV;
1084 reason = "unsupported class";
1085 goto err_out;
1088 tf.protocol = ATA_PROT_PIO;
1090 err_mask = ata_exec_internal(ap, dev, &tf, DMA_FROM_DEVICE,
1091 id, sizeof(id[0]) * ATA_ID_WORDS);
1093 if (err_mask) {
1094 rc = -EIO;
1095 reason = "I/O error";
1097 if (err_mask & ~AC_ERR_DEV)
1098 goto err_out;
1101 * arg! EDD works for all test cases, but seems to return
1102 * the ATA signature for some ATAPI devices. Until the
1103 * reason for this is found and fixed, we fix up the mess
1104 * here. If IDENTIFY DEVICE returns command aborted
1105 * (as ATAPI devices do), then we issue an
1106 * IDENTIFY PACKET DEVICE.
1108 * ATA software reset (SRST, the default) does not appear
1109 * to have this problem.
1111 if ((using_edd) && (class == ATA_DEV_ATA)) {
1112 u8 err = tf.feature;
1113 if (err & ATA_ABORTED) {
1114 class = ATA_DEV_ATAPI;
1115 goto retry;
1118 goto err_out;
1121 swap_buf_le16(id, ATA_ID_WORDS);
1123 /* print device capabilities */
1124 printk(KERN_DEBUG "ata%u: dev %u cfg "
1125 "49:%04x 82:%04x 83:%04x 84:%04x 85:%04x 86:%04x 87:%04x 88:%04x\n",
1126 ap->id, dev->devno,
1127 id[49], id[82], id[83], id[84], id[85], id[86], id[87], id[88]);
1129 /* sanity check */
1130 if ((class == ATA_DEV_ATA) != ata_id_is_ata(id)) {
1131 rc = -EINVAL;
1132 reason = "device reports illegal type";
1133 goto err_out;
1136 if (post_reset && class == ATA_DEV_ATA) {
1138 * The exact sequence expected by certain pre-ATA4 drives is:
1139 * SRST RESET
1140 * IDENTIFY
1141 * INITIALIZE DEVICE PARAMETERS
1142 * anything else..
1143 * Some drives were very specific about that exact sequence.
1145 if (ata_id_major_version(id) < 4 || !ata_id_has_lba(id)) {
1146 err_mask = ata_dev_init_params(ap, dev);
1147 if (err_mask) {
1148 rc = -EIO;
1149 reason = "INIT_DEV_PARAMS failed";
1150 goto err_out;
1153 /* current CHS translation info (id[53-58]) might be
1154 * changed. reread the identify device info.
1156 post_reset = 0;
1157 goto retry;
1161 *p_class = class;
1162 *p_id = id;
1163 return 0;
1165 err_out:
1166 printk(KERN_WARNING "ata%u: dev %u failed to IDENTIFY (%s)\n",
1167 ap->id, dev->devno, reason);
1168 kfree(id);
1169 return rc;
1172 static inline u8 ata_dev_knobble(const struct ata_port *ap,
1173 struct ata_device *dev)
1175 return ((ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(dev->id)));
1179 * ata_dev_configure - Configure the specified ATA/ATAPI device
1180 * @ap: Port on which target device resides
1181 * @dev: Target device to configure
1182 * @print_info: Enable device info printout
1184 * Configure @dev according to @dev->id. Generic and low-level
1185 * driver specific fixups are also applied.
1187 * LOCKING:
1188 * Kernel thread context (may sleep)
1190 * RETURNS:
1191 * 0 on success, -errno otherwise
1193 static int ata_dev_configure(struct ata_port *ap, struct ata_device *dev,
1194 int print_info)
1196 const u16 *id = dev->id;
1197 unsigned int xfer_mask;
1198 int i, rc;
1200 if (!ata_dev_present(dev)) {
1201 DPRINTK("ENTER/EXIT (host %u, dev %u) -- nodev\n",
1202 ap->id, dev->devno);
1203 return 0;
1206 DPRINTK("ENTER, host %u, dev %u\n", ap->id, dev->devno);
1208 /* initialize to-be-configured parameters */
1209 dev->flags = 0;
1210 dev->max_sectors = 0;
1211 dev->cdb_len = 0;
1212 dev->n_sectors = 0;
1213 dev->cylinders = 0;
1214 dev->heads = 0;
1215 dev->sectors = 0;
1218 * common ATA, ATAPI feature tests
1221 /* we require DMA support (bits 8 of word 49) */
1222 if (!ata_id_has_dma(id)) {
1223 printk(KERN_DEBUG "ata%u: no dma\n", ap->id);
1224 rc = -EINVAL;
1225 goto err_out_nosup;
1228 /* find max transfer mode; for printk only */
1229 xfer_mask = ata_id_xfermask(id);
1231 ata_dump_id(id);
1233 /* ATA-specific feature tests */
1234 if (dev->class == ATA_DEV_ATA) {
1235 dev->n_sectors = ata_id_n_sectors(id);
1237 if (ata_id_has_lba(id)) {
1238 const char *lba_desc;
1240 lba_desc = "LBA";
1241 dev->flags |= ATA_DFLAG_LBA;
1242 if (ata_id_has_lba48(id)) {
1243 dev->flags |= ATA_DFLAG_LBA48;
1244 lba_desc = "LBA48";
1247 /* print device info to dmesg */
1248 if (print_info)
1249 printk(KERN_INFO "ata%u: dev %u ATA-%d, "
1250 "max %s, %Lu sectors: %s\n",
1251 ap->id, dev->devno,
1252 ata_id_major_version(id),
1253 ata_mode_string(xfer_mask),
1254 (unsigned long long)dev->n_sectors,
1255 lba_desc);
1256 } else {
1257 /* CHS */
1259 /* Default translation */
1260 dev->cylinders = id[1];
1261 dev->heads = id[3];
1262 dev->sectors = id[6];
1264 if (ata_id_current_chs_valid(id)) {
1265 /* Current CHS translation is valid. */
1266 dev->cylinders = id[54];
1267 dev->heads = id[55];
1268 dev->sectors = id[56];
1271 /* print device info to dmesg */
1272 if (print_info)
1273 printk(KERN_INFO "ata%u: dev %u ATA-%d, "
1274 "max %s, %Lu sectors: CHS %u/%u/%u\n",
1275 ap->id, dev->devno,
1276 ata_id_major_version(id),
1277 ata_mode_string(xfer_mask),
1278 (unsigned long long)dev->n_sectors,
1279 dev->cylinders, dev->heads, dev->sectors);
1282 dev->cdb_len = 16;
1285 /* ATAPI-specific feature tests */
1286 else if (dev->class == ATA_DEV_ATAPI) {
1287 rc = atapi_cdb_len(id);
1288 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
1289 printk(KERN_WARNING "ata%u: unsupported CDB len\n", ap->id);
1290 rc = -EINVAL;
1291 goto err_out_nosup;
1293 dev->cdb_len = (unsigned int) rc;
1295 /* print device info to dmesg */
1296 if (print_info)
1297 printk(KERN_INFO "ata%u: dev %u ATAPI, max %s\n",
1298 ap->id, dev->devno, ata_mode_string(xfer_mask));
1301 ap->host->max_cmd_len = 0;
1302 for (i = 0; i < ATA_MAX_DEVICES; i++)
1303 ap->host->max_cmd_len = max_t(unsigned int,
1304 ap->host->max_cmd_len,
1305 ap->device[i].cdb_len);
1307 /* limit bridge transfers to udma5, 200 sectors */
1308 if (ata_dev_knobble(ap, dev)) {
1309 if (print_info)
1310 printk(KERN_INFO "ata%u(%u): applying bridge limits\n",
1311 ap->id, dev->devno);
1312 ap->udma_mask &= ATA_UDMA5;
1313 dev->max_sectors = ATA_MAX_SECTORS;
1316 if (ap->ops->dev_config)
1317 ap->ops->dev_config(ap, dev);
1319 DPRINTK("EXIT, drv_stat = 0x%x\n", ata_chk_status(ap));
1320 return 0;
1322 err_out_nosup:
1323 printk(KERN_WARNING "ata%u: dev %u not supported, ignoring\n",
1324 ap->id, dev->devno);
1325 DPRINTK("EXIT, err\n");
1326 return rc;
1330 * ata_bus_probe - Reset and probe ATA bus
1331 * @ap: Bus to probe
1333 * Master ATA bus probing function. Initiates a hardware-dependent
1334 * bus reset, then attempts to identify any devices found on
1335 * the bus.
1337 * LOCKING:
1338 * PCI/etc. bus probe sem.
1340 * RETURNS:
1341 * Zero on success, non-zero on error.
1344 static int ata_bus_probe(struct ata_port *ap)
1346 unsigned int classes[ATA_MAX_DEVICES];
1347 unsigned int i, rc, found = 0;
1349 ata_port_probe(ap);
1351 /* reset and determine device classes */
1352 for (i = 0; i < ATA_MAX_DEVICES; i++)
1353 classes[i] = ATA_DEV_UNKNOWN;
1355 if (ap->ops->probe_reset) {
1356 rc = ap->ops->probe_reset(ap, classes);
1357 if (rc) {
1358 printk("ata%u: reset failed (errno=%d)\n", ap->id, rc);
1359 return rc;
1361 } else {
1362 ap->ops->phy_reset(ap);
1364 if (!(ap->flags & ATA_FLAG_PORT_DISABLED))
1365 for (i = 0; i < ATA_MAX_DEVICES; i++)
1366 classes[i] = ap->device[i].class;
1368 ata_port_probe(ap);
1371 for (i = 0; i < ATA_MAX_DEVICES; i++)
1372 if (classes[i] == ATA_DEV_UNKNOWN)
1373 classes[i] = ATA_DEV_NONE;
1375 /* read IDENTIFY page and configure devices */
1376 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1377 struct ata_device *dev = &ap->device[i];
1379 dev->class = classes[i];
1381 if (!ata_dev_present(dev))
1382 continue;
1384 WARN_ON(dev->id != NULL);
1385 if (ata_dev_read_id(ap, dev, &dev->class, 1, &dev->id)) {
1386 dev->class = ATA_DEV_NONE;
1387 continue;
1390 if (ata_dev_configure(ap, dev, 1)) {
1391 dev->class++; /* disable device */
1392 continue;
1395 found = 1;
1398 if (!found)
1399 goto err_out_disable;
1401 ata_set_mode(ap);
1402 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1403 goto err_out_disable;
1405 return 0;
1407 err_out_disable:
1408 ap->ops->port_disable(ap);
1409 return -1;
1413 * ata_port_probe - Mark port as enabled
1414 * @ap: Port for which we indicate enablement
1416 * Modify @ap data structure such that the system
1417 * thinks that the entire port is enabled.
1419 * LOCKING: host_set lock, or some other form of
1420 * serialization.
1423 void ata_port_probe(struct ata_port *ap)
1425 ap->flags &= ~ATA_FLAG_PORT_DISABLED;
1429 * sata_print_link_status - Print SATA link status
1430 * @ap: SATA port to printk link status about
1432 * This function prints link speed and status of a SATA link.
1434 * LOCKING:
1435 * None.
1437 static void sata_print_link_status(struct ata_port *ap)
1439 u32 sstatus, tmp;
1440 const char *speed;
1442 if (!ap->ops->scr_read)
1443 return;
1445 sstatus = scr_read(ap, SCR_STATUS);
1447 if (sata_dev_present(ap)) {
1448 tmp = (sstatus >> 4) & 0xf;
1449 if (tmp & (1 << 0))
1450 speed = "1.5";
1451 else if (tmp & (1 << 1))
1452 speed = "3.0";
1453 else
1454 speed = "<unknown>";
1455 printk(KERN_INFO "ata%u: SATA link up %s Gbps (SStatus %X)\n",
1456 ap->id, speed, sstatus);
1457 } else {
1458 printk(KERN_INFO "ata%u: SATA link down (SStatus %X)\n",
1459 ap->id, sstatus);
1464 * __sata_phy_reset - Wake/reset a low-level SATA PHY
1465 * @ap: SATA port associated with target SATA PHY.
1467 * This function issues commands to standard SATA Sxxx
1468 * PHY registers, to wake up the phy (and device), and
1469 * clear any reset condition.
1471 * LOCKING:
1472 * PCI/etc. bus probe sem.
1475 void __sata_phy_reset(struct ata_port *ap)
1477 u32 sstatus;
1478 unsigned long timeout = jiffies + (HZ * 5);
1480 if (ap->flags & ATA_FLAG_SATA_RESET) {
1481 /* issue phy wake/reset */
1482 scr_write_flush(ap, SCR_CONTROL, 0x301);
1483 /* Couldn't find anything in SATA I/II specs, but
1484 * AHCI-1.1 10.4.2 says at least 1 ms. */
1485 mdelay(1);
1487 scr_write_flush(ap, SCR_CONTROL, 0x300); /* phy wake/clear reset */
1489 /* wait for phy to become ready, if necessary */
1490 do {
1491 msleep(200);
1492 sstatus = scr_read(ap, SCR_STATUS);
1493 if ((sstatus & 0xf) != 1)
1494 break;
1495 } while (time_before(jiffies, timeout));
1497 /* print link status */
1498 sata_print_link_status(ap);
1500 /* TODO: phy layer with polling, timeouts, etc. */
1501 if (sata_dev_present(ap))
1502 ata_port_probe(ap);
1503 else
1504 ata_port_disable(ap);
1506 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1507 return;
1509 if (ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT)) {
1510 ata_port_disable(ap);
1511 return;
1514 ap->cbl = ATA_CBL_SATA;
1518 * sata_phy_reset - Reset SATA bus.
1519 * @ap: SATA port associated with target SATA PHY.
1521 * This function resets the SATA bus, and then probes
1522 * the bus for devices.
1524 * LOCKING:
1525 * PCI/etc. bus probe sem.
1528 void sata_phy_reset(struct ata_port *ap)
1530 __sata_phy_reset(ap);
1531 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1532 return;
1533 ata_bus_reset(ap);
1537 * ata_port_disable - Disable port.
1538 * @ap: Port to be disabled.
1540 * Modify @ap data structure such that the system
1541 * thinks that the entire port is disabled, and should
1542 * never attempt to probe or communicate with devices
1543 * on this port.
1545 * LOCKING: host_set lock, or some other form of
1546 * serialization.
1549 void ata_port_disable(struct ata_port *ap)
1551 ap->device[0].class = ATA_DEV_NONE;
1552 ap->device[1].class = ATA_DEV_NONE;
1553 ap->flags |= ATA_FLAG_PORT_DISABLED;
1557 * This mode timing computation functionality is ported over from
1558 * drivers/ide/ide-timing.h and was originally written by Vojtech Pavlik
1561 * PIO 0-5, MWDMA 0-2 and UDMA 0-6 timings (in nanoseconds).
1562 * These were taken from ATA/ATAPI-6 standard, rev 0a, except
1563 * for PIO 5, which is a nonstandard extension and UDMA6, which
1564 * is currently supported only by Maxtor drives.
1567 static const struct ata_timing ata_timing[] = {
1569 { XFER_UDMA_6, 0, 0, 0, 0, 0, 0, 0, 15 },
1570 { XFER_UDMA_5, 0, 0, 0, 0, 0, 0, 0, 20 },
1571 { XFER_UDMA_4, 0, 0, 0, 0, 0, 0, 0, 30 },
1572 { XFER_UDMA_3, 0, 0, 0, 0, 0, 0, 0, 45 },
1574 { XFER_UDMA_2, 0, 0, 0, 0, 0, 0, 0, 60 },
1575 { XFER_UDMA_1, 0, 0, 0, 0, 0, 0, 0, 80 },
1576 { XFER_UDMA_0, 0, 0, 0, 0, 0, 0, 0, 120 },
1578 /* { XFER_UDMA_SLOW, 0, 0, 0, 0, 0, 0, 0, 150 }, */
1580 { XFER_MW_DMA_2, 25, 0, 0, 0, 70, 25, 120, 0 },
1581 { XFER_MW_DMA_1, 45, 0, 0, 0, 80, 50, 150, 0 },
1582 { XFER_MW_DMA_0, 60, 0, 0, 0, 215, 215, 480, 0 },
1584 { XFER_SW_DMA_2, 60, 0, 0, 0, 120, 120, 240, 0 },
1585 { XFER_SW_DMA_1, 90, 0, 0, 0, 240, 240, 480, 0 },
1586 { XFER_SW_DMA_0, 120, 0, 0, 0, 480, 480, 960, 0 },
1588 /* { XFER_PIO_5, 20, 50, 30, 100, 50, 30, 100, 0 }, */
1589 { XFER_PIO_4, 25, 70, 25, 120, 70, 25, 120, 0 },
1590 { XFER_PIO_3, 30, 80, 70, 180, 80, 70, 180, 0 },
1592 { XFER_PIO_2, 30, 290, 40, 330, 100, 90, 240, 0 },
1593 { XFER_PIO_1, 50, 290, 93, 383, 125, 100, 383, 0 },
1594 { XFER_PIO_0, 70, 290, 240, 600, 165, 150, 600, 0 },
1596 /* { XFER_PIO_SLOW, 120, 290, 240, 960, 290, 240, 960, 0 }, */
1598 { 0xFF }
1601 #define ENOUGH(v,unit) (((v)-1)/(unit)+1)
1602 #define EZ(v,unit) ((v)?ENOUGH(v,unit):0)
1604 static void ata_timing_quantize(const struct ata_timing *t, struct ata_timing *q, int T, int UT)
1606 q->setup = EZ(t->setup * 1000, T);
1607 q->act8b = EZ(t->act8b * 1000, T);
1608 q->rec8b = EZ(t->rec8b * 1000, T);
1609 q->cyc8b = EZ(t->cyc8b * 1000, T);
1610 q->active = EZ(t->active * 1000, T);
1611 q->recover = EZ(t->recover * 1000, T);
1612 q->cycle = EZ(t->cycle * 1000, T);
1613 q->udma = EZ(t->udma * 1000, UT);
1616 void ata_timing_merge(const struct ata_timing *a, const struct ata_timing *b,
1617 struct ata_timing *m, unsigned int what)
1619 if (what & ATA_TIMING_SETUP ) m->setup = max(a->setup, b->setup);
1620 if (what & ATA_TIMING_ACT8B ) m->act8b = max(a->act8b, b->act8b);
1621 if (what & ATA_TIMING_REC8B ) m->rec8b = max(a->rec8b, b->rec8b);
1622 if (what & ATA_TIMING_CYC8B ) m->cyc8b = max(a->cyc8b, b->cyc8b);
1623 if (what & ATA_TIMING_ACTIVE ) m->active = max(a->active, b->active);
1624 if (what & ATA_TIMING_RECOVER) m->recover = max(a->recover, b->recover);
1625 if (what & ATA_TIMING_CYCLE ) m->cycle = max(a->cycle, b->cycle);
1626 if (what & ATA_TIMING_UDMA ) m->udma = max(a->udma, b->udma);
1629 static const struct ata_timing* ata_timing_find_mode(unsigned short speed)
1631 const struct ata_timing *t;
1633 for (t = ata_timing; t->mode != speed; t++)
1634 if (t->mode == 0xFF)
1635 return NULL;
1636 return t;
1639 int ata_timing_compute(struct ata_device *adev, unsigned short speed,
1640 struct ata_timing *t, int T, int UT)
1642 const struct ata_timing *s;
1643 struct ata_timing p;
1646 * Find the mode.
1649 if (!(s = ata_timing_find_mode(speed)))
1650 return -EINVAL;
1652 memcpy(t, s, sizeof(*s));
1655 * If the drive is an EIDE drive, it can tell us it needs extended
1656 * PIO/MW_DMA cycle timing.
1659 if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE drive */
1660 memset(&p, 0, sizeof(p));
1661 if(speed >= XFER_PIO_0 && speed <= XFER_SW_DMA_0) {
1662 if (speed <= XFER_PIO_2) p.cycle = p.cyc8b = adev->id[ATA_ID_EIDE_PIO];
1663 else p.cycle = p.cyc8b = adev->id[ATA_ID_EIDE_PIO_IORDY];
1664 } else if(speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2) {
1665 p.cycle = adev->id[ATA_ID_EIDE_DMA_MIN];
1667 ata_timing_merge(&p, t, t, ATA_TIMING_CYCLE | ATA_TIMING_CYC8B);
1671 * Convert the timing to bus clock counts.
1674 ata_timing_quantize(t, t, T, UT);
1677 * Even in DMA/UDMA modes we still use PIO access for IDENTIFY,
1678 * S.M.A.R.T * and some other commands. We have to ensure that the
1679 * DMA cycle timing is slower/equal than the fastest PIO timing.
1682 if (speed > XFER_PIO_4) {
1683 ata_timing_compute(adev, adev->pio_mode, &p, T, UT);
1684 ata_timing_merge(&p, t, t, ATA_TIMING_ALL);
1688 * Lengthen active & recovery time so that cycle time is correct.
1691 if (t->act8b + t->rec8b < t->cyc8b) {
1692 t->act8b += (t->cyc8b - (t->act8b + t->rec8b)) / 2;
1693 t->rec8b = t->cyc8b - t->act8b;
1696 if (t->active + t->recover < t->cycle) {
1697 t->active += (t->cycle - (t->active + t->recover)) / 2;
1698 t->recover = t->cycle - t->active;
1701 return 0;
1704 static void ata_dev_set_mode(struct ata_port *ap, struct ata_device *dev)
1706 if (!ata_dev_present(dev) || (ap->flags & ATA_FLAG_PORT_DISABLED))
1707 return;
1709 if (dev->xfer_shift == ATA_SHIFT_PIO)
1710 dev->flags |= ATA_DFLAG_PIO;
1712 ata_dev_set_xfermode(ap, dev);
1714 if (ata_dev_revalidate(ap, dev, 0)) {
1715 printk(KERN_ERR "ata%u: failed to revalidate after set "
1716 "xfermode, disabled\n", ap->id);
1717 ata_port_disable(ap);
1720 DPRINTK("xfer_shift=%u, xfer_mode=0x%x\n",
1721 dev->xfer_shift, (int)dev->xfer_mode);
1723 printk(KERN_INFO "ata%u: dev %u configured for %s\n",
1724 ap->id, dev->devno,
1725 ata_mode_string(ata_xfer_mode2mask(dev->xfer_mode)));
1728 static int ata_host_set_pio(struct ata_port *ap)
1730 int i;
1732 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1733 struct ata_device *dev = &ap->device[i];
1735 if (!ata_dev_present(dev))
1736 continue;
1738 if (!dev->pio_mode) {
1739 printk(KERN_WARNING "ata%u: no PIO support\n", ap->id);
1740 return -1;
1743 dev->xfer_mode = dev->pio_mode;
1744 dev->xfer_shift = ATA_SHIFT_PIO;
1745 if (ap->ops->set_piomode)
1746 ap->ops->set_piomode(ap, dev);
1749 return 0;
1752 static void ata_host_set_dma(struct ata_port *ap)
1754 int i;
1756 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1757 struct ata_device *dev = &ap->device[i];
1759 if (!ata_dev_present(dev) || !dev->dma_mode)
1760 continue;
1762 dev->xfer_mode = dev->dma_mode;
1763 dev->xfer_shift = ata_xfer_mode2shift(dev->dma_mode);
1764 if (ap->ops->set_dmamode)
1765 ap->ops->set_dmamode(ap, dev);
1770 * ata_set_mode - Program timings and issue SET FEATURES - XFER
1771 * @ap: port on which timings will be programmed
1773 * Set ATA device disk transfer mode (PIO3, UDMA6, etc.).
1775 * LOCKING:
1776 * PCI/etc. bus probe sem.
1778 static void ata_set_mode(struct ata_port *ap)
1780 int i, rc;
1782 /* step 1: calculate xfer_mask */
1783 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1784 struct ata_device *dev = &ap->device[i];
1785 unsigned int xfer_mask;
1787 if (!ata_dev_present(dev))
1788 continue;
1790 xfer_mask = ata_dev_xfermask(ap, dev);
1792 dev->pio_mode = ata_xfer_mask2mode(xfer_mask & ATA_MASK_PIO);
1793 dev->dma_mode = ata_xfer_mask2mode(xfer_mask & (ATA_MASK_MWDMA |
1794 ATA_MASK_UDMA));
1797 /* step 2: always set host PIO timings */
1798 rc = ata_host_set_pio(ap);
1799 if (rc)
1800 goto err_out;
1802 /* step 3: set host DMA timings */
1803 ata_host_set_dma(ap);
1805 /* step 4: update devices' xfer mode */
1806 for (i = 0; i < ATA_MAX_DEVICES; i++)
1807 ata_dev_set_mode(ap, &ap->device[i]);
1809 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1810 return;
1812 if (ap->ops->post_set_mode)
1813 ap->ops->post_set_mode(ap);
1815 return;
1817 err_out:
1818 ata_port_disable(ap);
1822 * ata_tf_to_host - issue ATA taskfile to host controller
1823 * @ap: port to which command is being issued
1824 * @tf: ATA taskfile register set
1826 * Issues ATA taskfile register set to ATA host controller,
1827 * with proper synchronization with interrupt handler and
1828 * other threads.
1830 * LOCKING:
1831 * spin_lock_irqsave(host_set lock)
1834 static inline void ata_tf_to_host(struct ata_port *ap,
1835 const struct ata_taskfile *tf)
1837 ap->ops->tf_load(ap, tf);
1838 ap->ops->exec_command(ap, tf);
1842 * ata_busy_sleep - sleep until BSY clears, or timeout
1843 * @ap: port containing status register to be polled
1844 * @tmout_pat: impatience timeout
1845 * @tmout: overall timeout
1847 * Sleep until ATA Status register bit BSY clears,
1848 * or a timeout occurs.
1850 * LOCKING: None.
1853 unsigned int ata_busy_sleep (struct ata_port *ap,
1854 unsigned long tmout_pat, unsigned long tmout)
1856 unsigned long timer_start, timeout;
1857 u8 status;
1859 status = ata_busy_wait(ap, ATA_BUSY, 300);
1860 timer_start = jiffies;
1861 timeout = timer_start + tmout_pat;
1862 while ((status & ATA_BUSY) && (time_before(jiffies, timeout))) {
1863 msleep(50);
1864 status = ata_busy_wait(ap, ATA_BUSY, 3);
1867 if (status & ATA_BUSY)
1868 printk(KERN_WARNING "ata%u is slow to respond, "
1869 "please be patient\n", ap->id);
1871 timeout = timer_start + tmout;
1872 while ((status & ATA_BUSY) && (time_before(jiffies, timeout))) {
1873 msleep(50);
1874 status = ata_chk_status(ap);
1877 if (status & ATA_BUSY) {
1878 printk(KERN_ERR "ata%u failed to respond (%lu secs)\n",
1879 ap->id, tmout / HZ);
1880 return 1;
1883 return 0;
1886 static void ata_bus_post_reset(struct ata_port *ap, unsigned int devmask)
1888 struct ata_ioports *ioaddr = &ap->ioaddr;
1889 unsigned int dev0 = devmask & (1 << 0);
1890 unsigned int dev1 = devmask & (1 << 1);
1891 unsigned long timeout;
1893 /* if device 0 was found in ata_devchk, wait for its
1894 * BSY bit to clear
1896 if (dev0)
1897 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1899 /* if device 1 was found in ata_devchk, wait for
1900 * register access, then wait for BSY to clear
1902 timeout = jiffies + ATA_TMOUT_BOOT;
1903 while (dev1) {
1904 u8 nsect, lbal;
1906 ap->ops->dev_select(ap, 1);
1907 if (ap->flags & ATA_FLAG_MMIO) {
1908 nsect = readb((void __iomem *) ioaddr->nsect_addr);
1909 lbal = readb((void __iomem *) ioaddr->lbal_addr);
1910 } else {
1911 nsect = inb(ioaddr->nsect_addr);
1912 lbal = inb(ioaddr->lbal_addr);
1914 if ((nsect == 1) && (lbal == 1))
1915 break;
1916 if (time_after(jiffies, timeout)) {
1917 dev1 = 0;
1918 break;
1920 msleep(50); /* give drive a breather */
1922 if (dev1)
1923 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1925 /* is all this really necessary? */
1926 ap->ops->dev_select(ap, 0);
1927 if (dev1)
1928 ap->ops->dev_select(ap, 1);
1929 if (dev0)
1930 ap->ops->dev_select(ap, 0);
1934 * ata_bus_edd - Issue EXECUTE DEVICE DIAGNOSTIC command.
1935 * @ap: Port to reset and probe
1937 * Use the EXECUTE DEVICE DIAGNOSTIC command to reset and
1938 * probe the bus. Not often used these days.
1940 * LOCKING:
1941 * PCI/etc. bus probe sem.
1942 * Obtains host_set lock.
1946 static unsigned int ata_bus_edd(struct ata_port *ap)
1948 struct ata_taskfile tf;
1949 unsigned long flags;
1951 /* set up execute-device-diag (bus reset) taskfile */
1952 /* also, take interrupts to a known state (disabled) */
1953 DPRINTK("execute-device-diag\n");
1954 ata_tf_init(ap, &tf, 0);
1955 tf.ctl |= ATA_NIEN;
1956 tf.command = ATA_CMD_EDD;
1957 tf.protocol = ATA_PROT_NODATA;
1959 /* do bus reset */
1960 spin_lock_irqsave(&ap->host_set->lock, flags);
1961 ata_tf_to_host(ap, &tf);
1962 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1964 /* spec says at least 2ms. but who knows with those
1965 * crazy ATAPI devices...
1967 msleep(150);
1969 return ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
1972 static unsigned int ata_bus_softreset(struct ata_port *ap,
1973 unsigned int devmask)
1975 struct ata_ioports *ioaddr = &ap->ioaddr;
1977 DPRINTK("ata%u: bus reset via SRST\n", ap->id);
1979 /* software reset. causes dev0 to be selected */
1980 if (ap->flags & ATA_FLAG_MMIO) {
1981 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1982 udelay(20); /* FIXME: flush */
1983 writeb(ap->ctl | ATA_SRST, (void __iomem *) ioaddr->ctl_addr);
1984 udelay(20); /* FIXME: flush */
1985 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1986 } else {
1987 outb(ap->ctl, ioaddr->ctl_addr);
1988 udelay(10);
1989 outb(ap->ctl | ATA_SRST, ioaddr->ctl_addr);
1990 udelay(10);
1991 outb(ap->ctl, ioaddr->ctl_addr);
1994 /* spec mandates ">= 2ms" before checking status.
1995 * We wait 150ms, because that was the magic delay used for
1996 * ATAPI devices in Hale Landis's ATADRVR, for the period of time
1997 * between when the ATA command register is written, and then
1998 * status is checked. Because waiting for "a while" before
1999 * checking status is fine, post SRST, we perform this magic
2000 * delay here as well.
2002 msleep(150);
2004 ata_bus_post_reset(ap, devmask);
2006 return 0;
2010 * ata_bus_reset - reset host port and associated ATA channel
2011 * @ap: port to reset
2013 * This is typically the first time we actually start issuing
2014 * commands to the ATA channel. We wait for BSY to clear, then
2015 * issue EXECUTE DEVICE DIAGNOSTIC command, polling for its
2016 * result. Determine what devices, if any, are on the channel
2017 * by looking at the device 0/1 error register. Look at the signature
2018 * stored in each device's taskfile registers, to determine if
2019 * the device is ATA or ATAPI.
2021 * LOCKING:
2022 * PCI/etc. bus probe sem.
2023 * Obtains host_set lock.
2025 * SIDE EFFECTS:
2026 * Sets ATA_FLAG_PORT_DISABLED if bus reset fails.
2029 void ata_bus_reset(struct ata_port *ap)
2031 struct ata_ioports *ioaddr = &ap->ioaddr;
2032 unsigned int slave_possible = ap->flags & ATA_FLAG_SLAVE_POSS;
2033 u8 err;
2034 unsigned int dev0, dev1 = 0, rc = 0, devmask = 0;
2036 DPRINTK("ENTER, host %u, port %u\n", ap->id, ap->port_no);
2038 /* determine if device 0/1 are present */
2039 if (ap->flags & ATA_FLAG_SATA_RESET)
2040 dev0 = 1;
2041 else {
2042 dev0 = ata_devchk(ap, 0);
2043 if (slave_possible)
2044 dev1 = ata_devchk(ap, 1);
2047 if (dev0)
2048 devmask |= (1 << 0);
2049 if (dev1)
2050 devmask |= (1 << 1);
2052 /* select device 0 again */
2053 ap->ops->dev_select(ap, 0);
2055 /* issue bus reset */
2056 if (ap->flags & ATA_FLAG_SRST)
2057 rc = ata_bus_softreset(ap, devmask);
2058 else if ((ap->flags & ATA_FLAG_SATA_RESET) == 0) {
2059 /* set up device control */
2060 if (ap->flags & ATA_FLAG_MMIO)
2061 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2062 else
2063 outb(ap->ctl, ioaddr->ctl_addr);
2064 rc = ata_bus_edd(ap);
2067 if (rc)
2068 goto err_out;
2071 * determine by signature whether we have ATA or ATAPI devices
2073 ap->device[0].class = ata_dev_try_classify(ap, 0, &err);
2074 if ((slave_possible) && (err != 0x81))
2075 ap->device[1].class = ata_dev_try_classify(ap, 1, &err);
2077 /* re-enable interrupts */
2078 if (ap->ioaddr.ctl_addr) /* FIXME: hack. create a hook instead */
2079 ata_irq_on(ap);
2081 /* is double-select really necessary? */
2082 if (ap->device[1].class != ATA_DEV_NONE)
2083 ap->ops->dev_select(ap, 1);
2084 if (ap->device[0].class != ATA_DEV_NONE)
2085 ap->ops->dev_select(ap, 0);
2087 /* if no devices were detected, disable this port */
2088 if ((ap->device[0].class == ATA_DEV_NONE) &&
2089 (ap->device[1].class == ATA_DEV_NONE))
2090 goto err_out;
2092 if (ap->flags & (ATA_FLAG_SATA_RESET | ATA_FLAG_SRST)) {
2093 /* set up device control for ATA_FLAG_SATA_RESET */
2094 if (ap->flags & ATA_FLAG_MMIO)
2095 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
2096 else
2097 outb(ap->ctl, ioaddr->ctl_addr);
2100 DPRINTK("EXIT\n");
2101 return;
2103 err_out:
2104 printk(KERN_ERR "ata%u: disabling port\n", ap->id);
2105 ap->ops->port_disable(ap);
2107 DPRINTK("EXIT\n");
2110 static int sata_phy_resume(struct ata_port *ap)
2112 unsigned long timeout = jiffies + (HZ * 5);
2113 u32 sstatus;
2115 scr_write_flush(ap, SCR_CONTROL, 0x300);
2117 /* Wait for phy to become ready, if necessary. */
2118 do {
2119 msleep(200);
2120 sstatus = scr_read(ap, SCR_STATUS);
2121 if ((sstatus & 0xf) != 1)
2122 return 0;
2123 } while (time_before(jiffies, timeout));
2125 return -1;
2129 * ata_std_probeinit - initialize probing
2130 * @ap: port to be probed
2132 * @ap is about to be probed. Initialize it. This function is
2133 * to be used as standard callback for ata_drive_probe_reset().
2135 * NOTE!!! Do not use this function as probeinit if a low level
2136 * driver implements only hardreset. Just pass NULL as probeinit
2137 * in that case. Using this function is probably okay but doing
2138 * so makes reset sequence different from the original
2139 * ->phy_reset implementation and Jeff nervous. :-P
2141 extern void ata_std_probeinit(struct ata_port *ap)
2143 if (ap->flags & ATA_FLAG_SATA && ap->ops->scr_read) {
2144 sata_phy_resume(ap);
2145 if (sata_dev_present(ap))
2146 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
2151 * ata_std_softreset - reset host port via ATA SRST
2152 * @ap: port to reset
2153 * @verbose: fail verbosely
2154 * @classes: resulting classes of attached devices
2156 * Reset host port using ATA SRST. This function is to be used
2157 * as standard callback for ata_drive_*_reset() functions.
2159 * LOCKING:
2160 * Kernel thread context (may sleep)
2162 * RETURNS:
2163 * 0 on success, -errno otherwise.
2165 int ata_std_softreset(struct ata_port *ap, int verbose, unsigned int *classes)
2167 unsigned int slave_possible = ap->flags & ATA_FLAG_SLAVE_POSS;
2168 unsigned int devmask = 0, err_mask;
2169 u8 err;
2171 DPRINTK("ENTER\n");
2173 if (ap->ops->scr_read && !sata_dev_present(ap)) {
2174 classes[0] = ATA_DEV_NONE;
2175 goto out;
2178 /* determine if device 0/1 are present */
2179 if (ata_devchk(ap, 0))
2180 devmask |= (1 << 0);
2181 if (slave_possible && ata_devchk(ap, 1))
2182 devmask |= (1 << 1);
2184 /* select device 0 again */
2185 ap->ops->dev_select(ap, 0);
2187 /* issue bus reset */
2188 DPRINTK("about to softreset, devmask=%x\n", devmask);
2189 err_mask = ata_bus_softreset(ap, devmask);
2190 if (err_mask) {
2191 if (verbose)
2192 printk(KERN_ERR "ata%u: SRST failed (err_mask=0x%x)\n",
2193 ap->id, err_mask);
2194 else
2195 DPRINTK("EXIT, softreset failed (err_mask=0x%x)\n",
2196 err_mask);
2197 return -EIO;
2200 /* determine by signature whether we have ATA or ATAPI devices */
2201 classes[0] = ata_dev_try_classify(ap, 0, &err);
2202 if (slave_possible && err != 0x81)
2203 classes[1] = ata_dev_try_classify(ap, 1, &err);
2205 out:
2206 DPRINTK("EXIT, classes[0]=%u [1]=%u\n", classes[0], classes[1]);
2207 return 0;
2211 * sata_std_hardreset - reset host port via SATA phy reset
2212 * @ap: port to reset
2213 * @verbose: fail verbosely
2214 * @class: resulting class of attached device
2216 * SATA phy-reset host port using DET bits of SControl register.
2217 * This function is to be used as standard callback for
2218 * ata_drive_*_reset().
2220 * LOCKING:
2221 * Kernel thread context (may sleep)
2223 * RETURNS:
2224 * 0 on success, -errno otherwise.
2226 int sata_std_hardreset(struct ata_port *ap, int verbose, unsigned int *class)
2228 DPRINTK("ENTER\n");
2230 /* Issue phy wake/reset */
2231 scr_write_flush(ap, SCR_CONTROL, 0x301);
2234 * Couldn't find anything in SATA I/II specs, but AHCI-1.1
2235 * 10.4.2 says at least 1 ms.
2237 msleep(1);
2239 /* Bring phy back */
2240 sata_phy_resume(ap);
2242 /* TODO: phy layer with polling, timeouts, etc. */
2243 if (!sata_dev_present(ap)) {
2244 *class = ATA_DEV_NONE;
2245 DPRINTK("EXIT, link offline\n");
2246 return 0;
2249 if (ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT)) {
2250 if (verbose)
2251 printk(KERN_ERR "ata%u: COMRESET failed "
2252 "(device not ready)\n", ap->id);
2253 else
2254 DPRINTK("EXIT, device not ready\n");
2255 return -EIO;
2258 ap->ops->dev_select(ap, 0); /* probably unnecessary */
2260 *class = ata_dev_try_classify(ap, 0, NULL);
2262 DPRINTK("EXIT, class=%u\n", *class);
2263 return 0;
2267 * ata_std_postreset - standard postreset callback
2268 * @ap: the target ata_port
2269 * @classes: classes of attached devices
2271 * This function is invoked after a successful reset. Note that
2272 * the device might have been reset more than once using
2273 * different reset methods before postreset is invoked.
2275 * This function is to be used as standard callback for
2276 * ata_drive_*_reset().
2278 * LOCKING:
2279 * Kernel thread context (may sleep)
2281 void ata_std_postreset(struct ata_port *ap, unsigned int *classes)
2283 DPRINTK("ENTER\n");
2285 /* set cable type if it isn't already set */
2286 if (ap->cbl == ATA_CBL_NONE && ap->flags & ATA_FLAG_SATA)
2287 ap->cbl = ATA_CBL_SATA;
2289 /* print link status */
2290 if (ap->cbl == ATA_CBL_SATA)
2291 sata_print_link_status(ap);
2293 /* re-enable interrupts */
2294 if (ap->ioaddr.ctl_addr) /* FIXME: hack. create a hook instead */
2295 ata_irq_on(ap);
2297 /* is double-select really necessary? */
2298 if (classes[0] != ATA_DEV_NONE)
2299 ap->ops->dev_select(ap, 1);
2300 if (classes[1] != ATA_DEV_NONE)
2301 ap->ops->dev_select(ap, 0);
2303 /* bail out if no device is present */
2304 if (classes[0] == ATA_DEV_NONE && classes[1] == ATA_DEV_NONE) {
2305 DPRINTK("EXIT, no device\n");
2306 return;
2309 /* set up device control */
2310 if (ap->ioaddr.ctl_addr) {
2311 if (ap->flags & ATA_FLAG_MMIO)
2312 writeb(ap->ctl, (void __iomem *) ap->ioaddr.ctl_addr);
2313 else
2314 outb(ap->ctl, ap->ioaddr.ctl_addr);
2317 DPRINTK("EXIT\n");
2321 * ata_std_probe_reset - standard probe reset method
2322 * @ap: prot to perform probe-reset
2323 * @classes: resulting classes of attached devices
2325 * The stock off-the-shelf ->probe_reset method.
2327 * LOCKING:
2328 * Kernel thread context (may sleep)
2330 * RETURNS:
2331 * 0 on success, -errno otherwise.
2333 int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes)
2335 ata_reset_fn_t hardreset;
2337 hardreset = NULL;
2338 if (ap->flags & ATA_FLAG_SATA && ap->ops->scr_read)
2339 hardreset = sata_std_hardreset;
2341 return ata_drive_probe_reset(ap, ata_std_probeinit,
2342 ata_std_softreset, hardreset,
2343 ata_std_postreset, classes);
2346 static int do_probe_reset(struct ata_port *ap, ata_reset_fn_t reset,
2347 ata_postreset_fn_t postreset,
2348 unsigned int *classes)
2350 int i, rc;
2352 for (i = 0; i < ATA_MAX_DEVICES; i++)
2353 classes[i] = ATA_DEV_UNKNOWN;
2355 rc = reset(ap, 0, classes);
2356 if (rc)
2357 return rc;
2359 /* If any class isn't ATA_DEV_UNKNOWN, consider classification
2360 * is complete and convert all ATA_DEV_UNKNOWN to
2361 * ATA_DEV_NONE.
2363 for (i = 0; i < ATA_MAX_DEVICES; i++)
2364 if (classes[i] != ATA_DEV_UNKNOWN)
2365 break;
2367 if (i < ATA_MAX_DEVICES)
2368 for (i = 0; i < ATA_MAX_DEVICES; i++)
2369 if (classes[i] == ATA_DEV_UNKNOWN)
2370 classes[i] = ATA_DEV_NONE;
2372 if (postreset)
2373 postreset(ap, classes);
2375 return classes[0] != ATA_DEV_UNKNOWN ? 0 : -ENODEV;
2379 * ata_drive_probe_reset - Perform probe reset with given methods
2380 * @ap: port to reset
2381 * @probeinit: probeinit method (can be NULL)
2382 * @softreset: softreset method (can be NULL)
2383 * @hardreset: hardreset method (can be NULL)
2384 * @postreset: postreset method (can be NULL)
2385 * @classes: resulting classes of attached devices
2387 * Reset the specified port and classify attached devices using
2388 * given methods. This function prefers softreset but tries all
2389 * possible reset sequences to reset and classify devices. This
2390 * function is intended to be used for constructing ->probe_reset
2391 * callback by low level drivers.
2393 * Reset methods should follow the following rules.
2395 * - Return 0 on sucess, -errno on failure.
2396 * - If classification is supported, fill classes[] with
2397 * recognized class codes.
2398 * - If classification is not supported, leave classes[] alone.
2399 * - If verbose is non-zero, print error message on failure;
2400 * otherwise, shut up.
2402 * LOCKING:
2403 * Kernel thread context (may sleep)
2405 * RETURNS:
2406 * 0 on success, -EINVAL if no reset method is avaliable, -ENODEV
2407 * if classification fails, and any error code from reset
2408 * methods.
2410 int ata_drive_probe_reset(struct ata_port *ap, ata_probeinit_fn_t probeinit,
2411 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
2412 ata_postreset_fn_t postreset, unsigned int *classes)
2414 int rc = -EINVAL;
2416 if (probeinit)
2417 probeinit(ap);
2419 if (softreset) {
2420 rc = do_probe_reset(ap, softreset, postreset, classes);
2421 if (rc == 0)
2422 return 0;
2425 if (!hardreset)
2426 return rc;
2428 rc = do_probe_reset(ap, hardreset, postreset, classes);
2429 if (rc == 0 || rc != -ENODEV)
2430 return rc;
2432 if (softreset)
2433 rc = do_probe_reset(ap, softreset, postreset, classes);
2435 return rc;
2439 * ata_dev_same_device - Determine whether new ID matches configured device
2440 * @ap: port on which the device to compare against resides
2441 * @dev: device to compare against
2442 * @new_class: class of the new device
2443 * @new_id: IDENTIFY page of the new device
2445 * Compare @new_class and @new_id against @dev and determine
2446 * whether @dev is the device indicated by @new_class and
2447 * @new_id.
2449 * LOCKING:
2450 * None.
2452 * RETURNS:
2453 * 1 if @dev matches @new_class and @new_id, 0 otherwise.
2455 static int ata_dev_same_device(struct ata_port *ap, struct ata_device *dev,
2456 unsigned int new_class, const u16 *new_id)
2458 const u16 *old_id = dev->id;
2459 unsigned char model[2][41], serial[2][21];
2460 u64 new_n_sectors;
2462 if (dev->class != new_class) {
2463 printk(KERN_INFO
2464 "ata%u: dev %u class mismatch %d != %d\n",
2465 ap->id, dev->devno, dev->class, new_class);
2466 return 0;
2469 ata_id_c_string(old_id, model[0], ATA_ID_PROD_OFS, sizeof(model[0]));
2470 ata_id_c_string(new_id, model[1], ATA_ID_PROD_OFS, sizeof(model[1]));
2471 ata_id_c_string(old_id, serial[0], ATA_ID_SERNO_OFS, sizeof(serial[0]));
2472 ata_id_c_string(new_id, serial[1], ATA_ID_SERNO_OFS, sizeof(serial[1]));
2473 new_n_sectors = ata_id_n_sectors(new_id);
2475 if (strcmp(model[0], model[1])) {
2476 printk(KERN_INFO
2477 "ata%u: dev %u model number mismatch '%s' != '%s'\n",
2478 ap->id, dev->devno, model[0], model[1]);
2479 return 0;
2482 if (strcmp(serial[0], serial[1])) {
2483 printk(KERN_INFO
2484 "ata%u: dev %u serial number mismatch '%s' != '%s'\n",
2485 ap->id, dev->devno, serial[0], serial[1]);
2486 return 0;
2489 if (dev->class == ATA_DEV_ATA && dev->n_sectors != new_n_sectors) {
2490 printk(KERN_INFO
2491 "ata%u: dev %u n_sectors mismatch %llu != %llu\n",
2492 ap->id, dev->devno, (unsigned long long)dev->n_sectors,
2493 (unsigned long long)new_n_sectors);
2494 return 0;
2497 return 1;
2501 * ata_dev_revalidate - Revalidate ATA device
2502 * @ap: port on which the device to revalidate resides
2503 * @dev: device to revalidate
2504 * @post_reset: is this revalidation after reset?
2506 * Re-read IDENTIFY page and make sure @dev is still attached to
2507 * the port.
2509 * LOCKING:
2510 * Kernel thread context (may sleep)
2512 * RETURNS:
2513 * 0 on success, negative errno otherwise
2515 int ata_dev_revalidate(struct ata_port *ap, struct ata_device *dev,
2516 int post_reset)
2518 unsigned int class;
2519 u16 *id;
2520 int rc;
2522 if (!ata_dev_present(dev))
2523 return -ENODEV;
2525 class = dev->class;
2526 id = NULL;
2528 /* allocate & read ID data */
2529 rc = ata_dev_read_id(ap, dev, &class, post_reset, &id);
2530 if (rc)
2531 goto fail;
2533 /* is the device still there? */
2534 if (!ata_dev_same_device(ap, dev, class, id)) {
2535 rc = -ENODEV;
2536 goto fail;
2539 kfree(dev->id);
2540 dev->id = id;
2542 /* configure device according to the new ID */
2543 return ata_dev_configure(ap, dev, 0);
2545 fail:
2546 printk(KERN_ERR "ata%u: dev %u revalidation failed (errno=%d)\n",
2547 ap->id, dev->devno, rc);
2548 kfree(id);
2549 return rc;
2552 static const char * const ata_dma_blacklist [] = {
2553 "WDC AC11000H",
2554 "WDC AC22100H",
2555 "WDC AC32500H",
2556 "WDC AC33100H",
2557 "WDC AC31600H",
2558 "WDC AC32100H",
2559 "WDC AC23200L",
2560 "Compaq CRD-8241B",
2561 "CRD-8400B",
2562 "CRD-8480B",
2563 "CRD-8482B",
2564 "CRD-84",
2565 "SanDisk SDP3B",
2566 "SanDisk SDP3B-64",
2567 "SANYO CD-ROM CRD",
2568 "HITACHI CDR-8",
2569 "HITACHI CDR-8335",
2570 "HITACHI CDR-8435",
2571 "Toshiba CD-ROM XM-6202B",
2572 "TOSHIBA CD-ROM XM-1702BC",
2573 "CD-532E-A",
2574 "E-IDE CD-ROM CR-840",
2575 "CD-ROM Drive/F5A",
2576 "WPI CDD-820",
2577 "SAMSUNG CD-ROM SC-148C",
2578 "SAMSUNG CD-ROM SC",
2579 "SanDisk SDP3B-64",
2580 "ATAPI CD-ROM DRIVE 40X MAXIMUM",
2581 "_NEC DV5800A",
2584 static int ata_dma_blacklisted(const struct ata_device *dev)
2586 unsigned char model_num[41];
2587 int i;
2589 ata_id_c_string(dev->id, model_num, ATA_ID_PROD_OFS, sizeof(model_num));
2591 for (i = 0; i < ARRAY_SIZE(ata_dma_blacklist); i++)
2592 if (!strcmp(ata_dma_blacklist[i], model_num))
2593 return 1;
2595 return 0;
2599 * ata_dev_xfermask - Compute supported xfermask of the given device
2600 * @ap: Port on which the device to compute xfermask for resides
2601 * @dev: Device to compute xfermask for
2603 * Compute supported xfermask of @dev. This function is
2604 * responsible for applying all known limits including host
2605 * controller limits, device blacklist, etc...
2607 * LOCKING:
2608 * None.
2610 * RETURNS:
2611 * Computed xfermask.
2613 static unsigned int ata_dev_xfermask(struct ata_port *ap,
2614 struct ata_device *dev)
2616 unsigned long xfer_mask;
2617 int i;
2619 xfer_mask = ata_pack_xfermask(ap->pio_mask, ap->mwdma_mask,
2620 ap->udma_mask);
2622 /* use port-wide xfermask for now */
2623 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2624 struct ata_device *d = &ap->device[i];
2625 if (!ata_dev_present(d))
2626 continue;
2627 xfer_mask &= ata_id_xfermask(d->id);
2628 if (ata_dma_blacklisted(d))
2629 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
2632 if (ata_dma_blacklisted(dev))
2633 printk(KERN_WARNING "ata%u: dev %u is on DMA blacklist, "
2634 "disabling DMA\n", ap->id, dev->devno);
2636 return xfer_mask;
2640 * ata_dev_set_xfermode - Issue SET FEATURES - XFER MODE command
2641 * @ap: Port associated with device @dev
2642 * @dev: Device to which command will be sent
2644 * Issue SET FEATURES - XFER MODE command to device @dev
2645 * on port @ap.
2647 * LOCKING:
2648 * PCI/etc. bus probe sem.
2651 static void ata_dev_set_xfermode(struct ata_port *ap, struct ata_device *dev)
2653 struct ata_taskfile tf;
2655 /* set up set-features taskfile */
2656 DPRINTK("set features - xfer mode\n");
2658 ata_tf_init(ap, &tf, dev->devno);
2659 tf.command = ATA_CMD_SET_FEATURES;
2660 tf.feature = SETFEATURES_XFER;
2661 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2662 tf.protocol = ATA_PROT_NODATA;
2663 tf.nsect = dev->xfer_mode;
2665 if (ata_exec_internal(ap, dev, &tf, DMA_NONE, NULL, 0)) {
2666 printk(KERN_ERR "ata%u: failed to set xfermode, disabled\n",
2667 ap->id);
2668 ata_port_disable(ap);
2671 DPRINTK("EXIT\n");
2675 * ata_dev_init_params - Issue INIT DEV PARAMS command
2676 * @ap: Port associated with device @dev
2677 * @dev: Device to which command will be sent
2679 * LOCKING:
2680 * Kernel thread context (may sleep)
2682 * RETURNS:
2683 * 0 on success, AC_ERR_* mask otherwise.
2686 static unsigned int ata_dev_init_params(struct ata_port *ap,
2687 struct ata_device *dev)
2689 struct ata_taskfile tf;
2690 unsigned int err_mask;
2691 u16 sectors = dev->id[6];
2692 u16 heads = dev->id[3];
2694 /* Number of sectors per track 1-255. Number of heads 1-16 */
2695 if (sectors < 1 || sectors > 255 || heads < 1 || heads > 16)
2696 return 0;
2698 /* set up init dev params taskfile */
2699 DPRINTK("init dev params \n");
2701 ata_tf_init(ap, &tf, dev->devno);
2702 tf.command = ATA_CMD_INIT_DEV_PARAMS;
2703 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2704 tf.protocol = ATA_PROT_NODATA;
2705 tf.nsect = sectors;
2706 tf.device |= (heads - 1) & 0x0f; /* max head = num. of heads - 1 */
2708 err_mask = ata_exec_internal(ap, dev, &tf, DMA_NONE, NULL, 0);
2710 DPRINTK("EXIT, err_mask=%x\n", err_mask);
2711 return err_mask;
2715 * ata_sg_clean - Unmap DMA memory associated with command
2716 * @qc: Command containing DMA memory to be released
2718 * Unmap all mapped DMA memory associated with this command.
2720 * LOCKING:
2721 * spin_lock_irqsave(host_set lock)
2724 static void ata_sg_clean(struct ata_queued_cmd *qc)
2726 struct ata_port *ap = qc->ap;
2727 struct scatterlist *sg = qc->__sg;
2728 int dir = qc->dma_dir;
2729 void *pad_buf = NULL;
2731 WARN_ON(!(qc->flags & ATA_QCFLAG_DMAMAP));
2732 WARN_ON(sg == NULL);
2734 if (qc->flags & ATA_QCFLAG_SINGLE)
2735 WARN_ON(qc->n_elem > 1);
2737 VPRINTK("unmapping %u sg elements\n", qc->n_elem);
2739 /* if we padded the buffer out to 32-bit bound, and data
2740 * xfer direction is from-device, we must copy from the
2741 * pad buffer back into the supplied buffer
2743 if (qc->pad_len && !(qc->tf.flags & ATA_TFLAG_WRITE))
2744 pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
2746 if (qc->flags & ATA_QCFLAG_SG) {
2747 if (qc->n_elem)
2748 dma_unmap_sg(ap->host_set->dev, sg, qc->n_elem, dir);
2749 /* restore last sg */
2750 sg[qc->orig_n_elem - 1].length += qc->pad_len;
2751 if (pad_buf) {
2752 struct scatterlist *psg = &qc->pad_sgent;
2753 void *addr = kmap_atomic(psg->page, KM_IRQ0);
2754 memcpy(addr + psg->offset, pad_buf, qc->pad_len);
2755 kunmap_atomic(addr, KM_IRQ0);
2757 } else {
2758 if (qc->n_elem)
2759 dma_unmap_single(ap->host_set->dev,
2760 sg_dma_address(&sg[0]), sg_dma_len(&sg[0]),
2761 dir);
2762 /* restore sg */
2763 sg->length += qc->pad_len;
2764 if (pad_buf)
2765 memcpy(qc->buf_virt + sg->length - qc->pad_len,
2766 pad_buf, qc->pad_len);
2769 qc->flags &= ~ATA_QCFLAG_DMAMAP;
2770 qc->__sg = NULL;
2774 * ata_fill_sg - Fill PCI IDE PRD table
2775 * @qc: Metadata associated with taskfile to be transferred
2777 * Fill PCI IDE PRD (scatter-gather) table with segments
2778 * associated with the current disk command.
2780 * LOCKING:
2781 * spin_lock_irqsave(host_set lock)
2784 static void ata_fill_sg(struct ata_queued_cmd *qc)
2786 struct ata_port *ap = qc->ap;
2787 struct scatterlist *sg;
2788 unsigned int idx;
2790 WARN_ON(qc->__sg == NULL);
2791 WARN_ON(qc->n_elem == 0 && qc->pad_len == 0);
2793 idx = 0;
2794 ata_for_each_sg(sg, qc) {
2795 u32 addr, offset;
2796 u32 sg_len, len;
2798 /* determine if physical DMA addr spans 64K boundary.
2799 * Note h/w doesn't support 64-bit, so we unconditionally
2800 * truncate dma_addr_t to u32.
2802 addr = (u32) sg_dma_address(sg);
2803 sg_len = sg_dma_len(sg);
2805 while (sg_len) {
2806 offset = addr & 0xffff;
2807 len = sg_len;
2808 if ((offset + sg_len) > 0x10000)
2809 len = 0x10000 - offset;
2811 ap->prd[idx].addr = cpu_to_le32(addr);
2812 ap->prd[idx].flags_len = cpu_to_le32(len & 0xffff);
2813 VPRINTK("PRD[%u] = (0x%X, 0x%X)\n", idx, addr, len);
2815 idx++;
2816 sg_len -= len;
2817 addr += len;
2821 if (idx)
2822 ap->prd[idx - 1].flags_len |= cpu_to_le32(ATA_PRD_EOT);
2825 * ata_check_atapi_dma - Check whether ATAPI DMA can be supported
2826 * @qc: Metadata associated with taskfile to check
2828 * Allow low-level driver to filter ATA PACKET commands, returning
2829 * a status indicating whether or not it is OK to use DMA for the
2830 * supplied PACKET command.
2832 * LOCKING:
2833 * spin_lock_irqsave(host_set lock)
2835 * RETURNS: 0 when ATAPI DMA can be used
2836 * nonzero otherwise
2838 int ata_check_atapi_dma(struct ata_queued_cmd *qc)
2840 struct ata_port *ap = qc->ap;
2841 int rc = 0; /* Assume ATAPI DMA is OK by default */
2843 if (ap->ops->check_atapi_dma)
2844 rc = ap->ops->check_atapi_dma(qc);
2846 return rc;
2849 * ata_qc_prep - Prepare taskfile for submission
2850 * @qc: Metadata associated with taskfile to be prepared
2852 * Prepare ATA taskfile for submission.
2854 * LOCKING:
2855 * spin_lock_irqsave(host_set lock)
2857 void ata_qc_prep(struct ata_queued_cmd *qc)
2859 if (!(qc->flags & ATA_QCFLAG_DMAMAP))
2860 return;
2862 ata_fill_sg(qc);
2866 * ata_sg_init_one - Associate command with memory buffer
2867 * @qc: Command to be associated
2868 * @buf: Memory buffer
2869 * @buflen: Length of memory buffer, in bytes.
2871 * Initialize the data-related elements of queued_cmd @qc
2872 * to point to a single memory buffer, @buf of byte length @buflen.
2874 * LOCKING:
2875 * spin_lock_irqsave(host_set lock)
2878 void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, unsigned int buflen)
2880 struct scatterlist *sg;
2882 qc->flags |= ATA_QCFLAG_SINGLE;
2884 memset(&qc->sgent, 0, sizeof(qc->sgent));
2885 qc->__sg = &qc->sgent;
2886 qc->n_elem = 1;
2887 qc->orig_n_elem = 1;
2888 qc->buf_virt = buf;
2890 sg = qc->__sg;
2891 sg_init_one(sg, buf, buflen);
2895 * ata_sg_init - Associate command with scatter-gather table.
2896 * @qc: Command to be associated
2897 * @sg: Scatter-gather table.
2898 * @n_elem: Number of elements in s/g table.
2900 * Initialize the data-related elements of queued_cmd @qc
2901 * to point to a scatter-gather table @sg, containing @n_elem
2902 * elements.
2904 * LOCKING:
2905 * spin_lock_irqsave(host_set lock)
2908 void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
2909 unsigned int n_elem)
2911 qc->flags |= ATA_QCFLAG_SG;
2912 qc->__sg = sg;
2913 qc->n_elem = n_elem;
2914 qc->orig_n_elem = n_elem;
2918 * ata_sg_setup_one - DMA-map the memory buffer associated with a command.
2919 * @qc: Command with memory buffer to be mapped.
2921 * DMA-map the memory buffer associated with queued_cmd @qc.
2923 * LOCKING:
2924 * spin_lock_irqsave(host_set lock)
2926 * RETURNS:
2927 * Zero on success, negative on error.
2930 static int ata_sg_setup_one(struct ata_queued_cmd *qc)
2932 struct ata_port *ap = qc->ap;
2933 int dir = qc->dma_dir;
2934 struct scatterlist *sg = qc->__sg;
2935 dma_addr_t dma_address;
2936 int trim_sg = 0;
2938 /* we must lengthen transfers to end on a 32-bit boundary */
2939 qc->pad_len = sg->length & 3;
2940 if (qc->pad_len) {
2941 void *pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
2942 struct scatterlist *psg = &qc->pad_sgent;
2944 WARN_ON(qc->dev->class != ATA_DEV_ATAPI);
2946 memset(pad_buf, 0, ATA_DMA_PAD_SZ);
2948 if (qc->tf.flags & ATA_TFLAG_WRITE)
2949 memcpy(pad_buf, qc->buf_virt + sg->length - qc->pad_len,
2950 qc->pad_len);
2952 sg_dma_address(psg) = ap->pad_dma + (qc->tag * ATA_DMA_PAD_SZ);
2953 sg_dma_len(psg) = ATA_DMA_PAD_SZ;
2954 /* trim sg */
2955 sg->length -= qc->pad_len;
2956 if (sg->length == 0)
2957 trim_sg = 1;
2959 DPRINTK("padding done, sg->length=%u pad_len=%u\n",
2960 sg->length, qc->pad_len);
2963 if (trim_sg) {
2964 qc->n_elem--;
2965 goto skip_map;
2968 dma_address = dma_map_single(ap->host_set->dev, qc->buf_virt,
2969 sg->length, dir);
2970 if (dma_mapping_error(dma_address)) {
2971 /* restore sg */
2972 sg->length += qc->pad_len;
2973 return -1;
2976 sg_dma_address(sg) = dma_address;
2977 sg_dma_len(sg) = sg->length;
2979 skip_map:
2980 DPRINTK("mapped buffer of %d bytes for %s\n", sg_dma_len(sg),
2981 qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
2983 return 0;
2987 * ata_sg_setup - DMA-map the scatter-gather table associated with a command.
2988 * @qc: Command with scatter-gather table to be mapped.
2990 * DMA-map the scatter-gather table associated with queued_cmd @qc.
2992 * LOCKING:
2993 * spin_lock_irqsave(host_set lock)
2995 * RETURNS:
2996 * Zero on success, negative on error.
3000 static int ata_sg_setup(struct ata_queued_cmd *qc)
3002 struct ata_port *ap = qc->ap;
3003 struct scatterlist *sg = qc->__sg;
3004 struct scatterlist *lsg = &sg[qc->n_elem - 1];
3005 int n_elem, pre_n_elem, dir, trim_sg = 0;
3007 VPRINTK("ENTER, ata%u\n", ap->id);
3008 WARN_ON(!(qc->flags & ATA_QCFLAG_SG));
3010 /* we must lengthen transfers to end on a 32-bit boundary */
3011 qc->pad_len = lsg->length & 3;
3012 if (qc->pad_len) {
3013 void *pad_buf = ap->pad + (qc->tag * ATA_DMA_PAD_SZ);
3014 struct scatterlist *psg = &qc->pad_sgent;
3015 unsigned int offset;
3017 WARN_ON(qc->dev->class != ATA_DEV_ATAPI);
3019 memset(pad_buf, 0, ATA_DMA_PAD_SZ);
3022 * psg->page/offset are used to copy to-be-written
3023 * data in this function or read data in ata_sg_clean.
3025 offset = lsg->offset + lsg->length - qc->pad_len;
3026 psg->page = nth_page(lsg->page, offset >> PAGE_SHIFT);
3027 psg->offset = offset_in_page(offset);
3029 if (qc->tf.flags & ATA_TFLAG_WRITE) {
3030 void *addr = kmap_atomic(psg->page, KM_IRQ0);
3031 memcpy(pad_buf, addr + psg->offset, qc->pad_len);
3032 kunmap_atomic(addr, KM_IRQ0);
3035 sg_dma_address(psg) = ap->pad_dma + (qc->tag * ATA_DMA_PAD_SZ);
3036 sg_dma_len(psg) = ATA_DMA_PAD_SZ;
3037 /* trim last sg */
3038 lsg->length -= qc->pad_len;
3039 if (lsg->length == 0)
3040 trim_sg = 1;
3042 DPRINTK("padding done, sg[%d].length=%u pad_len=%u\n",
3043 qc->n_elem - 1, lsg->length, qc->pad_len);
3046 pre_n_elem = qc->n_elem;
3047 if (trim_sg && pre_n_elem)
3048 pre_n_elem--;
3050 if (!pre_n_elem) {
3051 n_elem = 0;
3052 goto skip_map;
3055 dir = qc->dma_dir;
3056 n_elem = dma_map_sg(ap->host_set->dev, sg, pre_n_elem, dir);
3057 if (n_elem < 1) {
3058 /* restore last sg */
3059 lsg->length += qc->pad_len;
3060 return -1;
3063 DPRINTK("%d sg elements mapped\n", n_elem);
3065 skip_map:
3066 qc->n_elem = n_elem;
3068 return 0;
3072 * ata_poll_qc_complete - turn irq back on and finish qc
3073 * @qc: Command to complete
3074 * @err_mask: ATA status register content
3076 * LOCKING:
3077 * None. (grabs host lock)
3080 void ata_poll_qc_complete(struct ata_queued_cmd *qc)
3082 struct ata_port *ap = qc->ap;
3083 unsigned long flags;
3085 spin_lock_irqsave(&ap->host_set->lock, flags);
3086 ap->flags &= ~ATA_FLAG_NOINTR;
3087 ata_irq_on(ap);
3088 ata_qc_complete(qc);
3089 spin_unlock_irqrestore(&ap->host_set->lock, flags);
3093 * ata_pio_poll - poll using PIO, depending on current state
3094 * @ap: the target ata_port
3096 * LOCKING:
3097 * None. (executing in kernel thread context)
3099 * RETURNS:
3100 * timeout value to use
3103 static unsigned long ata_pio_poll(struct ata_port *ap)
3105 struct ata_queued_cmd *qc;
3106 u8 status;
3107 unsigned int poll_state = HSM_ST_UNKNOWN;
3108 unsigned int reg_state = HSM_ST_UNKNOWN;
3110 qc = ata_qc_from_tag(ap, ap->active_tag);
3111 WARN_ON(qc == NULL);
3113 switch (ap->hsm_task_state) {
3114 case HSM_ST:
3115 case HSM_ST_POLL:
3116 poll_state = HSM_ST_POLL;
3117 reg_state = HSM_ST;
3118 break;
3119 case HSM_ST_LAST:
3120 case HSM_ST_LAST_POLL:
3121 poll_state = HSM_ST_LAST_POLL;
3122 reg_state = HSM_ST_LAST;
3123 break;
3124 default:
3125 BUG();
3126 break;
3129 status = ata_chk_status(ap);
3130 if (status & ATA_BUSY) {
3131 if (time_after(jiffies, ap->pio_task_timeout)) {
3132 qc->err_mask |= AC_ERR_TIMEOUT;
3133 ap->hsm_task_state = HSM_ST_TMOUT;
3134 return 0;
3136 ap->hsm_task_state = poll_state;
3137 return ATA_SHORT_PAUSE;
3140 ap->hsm_task_state = reg_state;
3141 return 0;
3145 * ata_pio_complete - check if drive is busy or idle
3146 * @ap: the target ata_port
3148 * LOCKING:
3149 * None. (executing in kernel thread context)
3151 * RETURNS:
3152 * Non-zero if qc completed, zero otherwise.
3155 static int ata_pio_complete (struct ata_port *ap)
3157 struct ata_queued_cmd *qc;
3158 u8 drv_stat;
3161 * This is purely heuristic. This is a fast path. Sometimes when
3162 * we enter, BSY will be cleared in a chk-status or two. If not,
3163 * the drive is probably seeking or something. Snooze for a couple
3164 * msecs, then chk-status again. If still busy, fall back to
3165 * HSM_ST_POLL state.
3167 drv_stat = ata_busy_wait(ap, ATA_BUSY, 10);
3168 if (drv_stat & ATA_BUSY) {
3169 msleep(2);
3170 drv_stat = ata_busy_wait(ap, ATA_BUSY, 10);
3171 if (drv_stat & ATA_BUSY) {
3172 ap->hsm_task_state = HSM_ST_LAST_POLL;
3173 ap->pio_task_timeout = jiffies + ATA_TMOUT_PIO;
3174 return 0;
3178 qc = ata_qc_from_tag(ap, ap->active_tag);
3179 WARN_ON(qc == NULL);
3181 drv_stat = ata_wait_idle(ap);
3182 if (!ata_ok(drv_stat)) {
3183 qc->err_mask |= __ac_err_mask(drv_stat);
3184 ap->hsm_task_state = HSM_ST_ERR;
3185 return 0;
3188 ap->hsm_task_state = HSM_ST_IDLE;
3190 WARN_ON(qc->err_mask);
3191 ata_poll_qc_complete(qc);
3193 /* another command may start at this point */
3195 return 1;
3200 * swap_buf_le16 - swap halves of 16-bit words in place
3201 * @buf: Buffer to swap
3202 * @buf_words: Number of 16-bit words in buffer.
3204 * Swap halves of 16-bit words if needed to convert from
3205 * little-endian byte order to native cpu byte order, or
3206 * vice-versa.
3208 * LOCKING:
3209 * Inherited from caller.
3211 void swap_buf_le16(u16 *buf, unsigned int buf_words)
3213 #ifdef __BIG_ENDIAN
3214 unsigned int i;
3216 for (i = 0; i < buf_words; i++)
3217 buf[i] = le16_to_cpu(buf[i]);
3218 #endif /* __BIG_ENDIAN */
3222 * ata_mmio_data_xfer - Transfer data by MMIO
3223 * @ap: port to read/write
3224 * @buf: data buffer
3225 * @buflen: buffer length
3226 * @write_data: read/write
3228 * Transfer data from/to the device data register by MMIO.
3230 * LOCKING:
3231 * Inherited from caller.
3234 static void ata_mmio_data_xfer(struct ata_port *ap, unsigned char *buf,
3235 unsigned int buflen, int write_data)
3237 unsigned int i;
3238 unsigned int words = buflen >> 1;
3239 u16 *buf16 = (u16 *) buf;
3240 void __iomem *mmio = (void __iomem *)ap->ioaddr.data_addr;
3242 /* Transfer multiple of 2 bytes */
3243 if (write_data) {
3244 for (i = 0; i < words; i++)
3245 writew(le16_to_cpu(buf16[i]), mmio);
3246 } else {
3247 for (i = 0; i < words; i++)
3248 buf16[i] = cpu_to_le16(readw(mmio));
3251 /* Transfer trailing 1 byte, if any. */
3252 if (unlikely(buflen & 0x01)) {
3253 u16 align_buf[1] = { 0 };
3254 unsigned char *trailing_buf = buf + buflen - 1;
3256 if (write_data) {
3257 memcpy(align_buf, trailing_buf, 1);
3258 writew(le16_to_cpu(align_buf[0]), mmio);
3259 } else {
3260 align_buf[0] = cpu_to_le16(readw(mmio));
3261 memcpy(trailing_buf, align_buf, 1);
3267 * ata_pio_data_xfer - Transfer data by PIO
3268 * @ap: port to read/write
3269 * @buf: data buffer
3270 * @buflen: buffer length
3271 * @write_data: read/write
3273 * Transfer data from/to the device data register by PIO.
3275 * LOCKING:
3276 * Inherited from caller.
3279 static void ata_pio_data_xfer(struct ata_port *ap, unsigned char *buf,
3280 unsigned int buflen, int write_data)
3282 unsigned int words = buflen >> 1;
3284 /* Transfer multiple of 2 bytes */
3285 if (write_data)
3286 outsw(ap->ioaddr.data_addr, buf, words);
3287 else
3288 insw(ap->ioaddr.data_addr, buf, words);
3290 /* Transfer trailing 1 byte, if any. */
3291 if (unlikely(buflen & 0x01)) {
3292 u16 align_buf[1] = { 0 };
3293 unsigned char *trailing_buf = buf + buflen - 1;
3295 if (write_data) {
3296 memcpy(align_buf, trailing_buf, 1);
3297 outw(le16_to_cpu(align_buf[0]), ap->ioaddr.data_addr);
3298 } else {
3299 align_buf[0] = cpu_to_le16(inw(ap->ioaddr.data_addr));
3300 memcpy(trailing_buf, align_buf, 1);
3306 * ata_data_xfer - Transfer data from/to the data register.
3307 * @ap: port to read/write
3308 * @buf: data buffer
3309 * @buflen: buffer length
3310 * @do_write: read/write
3312 * Transfer data from/to the device data register.
3314 * LOCKING:
3315 * Inherited from caller.
3318 static void ata_data_xfer(struct ata_port *ap, unsigned char *buf,
3319 unsigned int buflen, int do_write)
3321 /* Make the crap hardware pay the costs not the good stuff */
3322 if (unlikely(ap->flags & ATA_FLAG_IRQ_MASK)) {
3323 unsigned long flags;
3324 local_irq_save(flags);
3325 if (ap->flags & ATA_FLAG_MMIO)
3326 ata_mmio_data_xfer(ap, buf, buflen, do_write);
3327 else
3328 ata_pio_data_xfer(ap, buf, buflen, do_write);
3329 local_irq_restore(flags);
3330 } else {
3331 if (ap->flags & ATA_FLAG_MMIO)
3332 ata_mmio_data_xfer(ap, buf, buflen, do_write);
3333 else
3334 ata_pio_data_xfer(ap, buf, buflen, do_write);
3339 * ata_pio_sector - Transfer ATA_SECT_SIZE (512 bytes) of data.
3340 * @qc: Command on going
3342 * Transfer ATA_SECT_SIZE of data from/to the ATA device.
3344 * LOCKING:
3345 * Inherited from caller.
3348 static void ata_pio_sector(struct ata_queued_cmd *qc)
3350 int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
3351 struct scatterlist *sg = qc->__sg;
3352 struct ata_port *ap = qc->ap;
3353 struct page *page;
3354 unsigned int offset;
3355 unsigned char *buf;
3357 if (qc->cursect == (qc->nsect - 1))
3358 ap->hsm_task_state = HSM_ST_LAST;
3360 page = sg[qc->cursg].page;
3361 offset = sg[qc->cursg].offset + qc->cursg_ofs * ATA_SECT_SIZE;
3363 /* get the current page and offset */
3364 page = nth_page(page, (offset >> PAGE_SHIFT));
3365 offset %= PAGE_SIZE;
3367 buf = kmap(page) + offset;
3369 qc->cursect++;
3370 qc->cursg_ofs++;
3372 if ((qc->cursg_ofs * ATA_SECT_SIZE) == (&sg[qc->cursg])->length) {
3373 qc->cursg++;
3374 qc->cursg_ofs = 0;
3377 DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
3379 /* do the actual data transfer */
3380 do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
3381 ata_data_xfer(ap, buf, ATA_SECT_SIZE, do_write);
3383 kunmap(page);
3387 * __atapi_pio_bytes - Transfer data from/to the ATAPI device.
3388 * @qc: Command on going
3389 * @bytes: number of bytes
3391 * Transfer Transfer data from/to the ATAPI device.
3393 * LOCKING:
3394 * Inherited from caller.
3398 static void __atapi_pio_bytes(struct ata_queued_cmd *qc, unsigned int bytes)
3400 int do_write = (qc->tf.flags & ATA_TFLAG_WRITE);
3401 struct scatterlist *sg = qc->__sg;
3402 struct ata_port *ap = qc->ap;
3403 struct page *page;
3404 unsigned char *buf;
3405 unsigned int offset, count;
3407 if (qc->curbytes + bytes >= qc->nbytes)
3408 ap->hsm_task_state = HSM_ST_LAST;
3410 next_sg:
3411 if (unlikely(qc->cursg >= qc->n_elem)) {
3413 * The end of qc->sg is reached and the device expects
3414 * more data to transfer. In order not to overrun qc->sg
3415 * and fulfill length specified in the byte count register,
3416 * - for read case, discard trailing data from the device
3417 * - for write case, padding zero data to the device
3419 u16 pad_buf[1] = { 0 };
3420 unsigned int words = bytes >> 1;
3421 unsigned int i;
3423 if (words) /* warning if bytes > 1 */
3424 printk(KERN_WARNING "ata%u: %u bytes trailing data\n",
3425 ap->id, bytes);
3427 for (i = 0; i < words; i++)
3428 ata_data_xfer(ap, (unsigned char*)pad_buf, 2, do_write);
3430 ap->hsm_task_state = HSM_ST_LAST;
3431 return;
3434 sg = &qc->__sg[qc->cursg];
3436 page = sg->page;
3437 offset = sg->offset + qc->cursg_ofs;
3439 /* get the current page and offset */
3440 page = nth_page(page, (offset >> PAGE_SHIFT));
3441 offset %= PAGE_SIZE;
3443 /* don't overrun current sg */
3444 count = min(sg->length - qc->cursg_ofs, bytes);
3446 /* don't cross page boundaries */
3447 count = min(count, (unsigned int)PAGE_SIZE - offset);
3449 buf = kmap(page) + offset;
3451 bytes -= count;
3452 qc->curbytes += count;
3453 qc->cursg_ofs += count;
3455 if (qc->cursg_ofs == sg->length) {
3456 qc->cursg++;
3457 qc->cursg_ofs = 0;
3460 DPRINTK("data %s\n", qc->tf.flags & ATA_TFLAG_WRITE ? "write" : "read");
3462 /* do the actual data transfer */
3463 ata_data_xfer(ap, buf, count, do_write);
3465 kunmap(page);
3467 if (bytes)
3468 goto next_sg;
3472 * atapi_pio_bytes - Transfer data from/to the ATAPI device.
3473 * @qc: Command on going
3475 * Transfer Transfer data from/to the ATAPI device.
3477 * LOCKING:
3478 * Inherited from caller.
3481 static void atapi_pio_bytes(struct ata_queued_cmd *qc)
3483 struct ata_port *ap = qc->ap;
3484 struct ata_device *dev = qc->dev;
3485 unsigned int ireason, bc_lo, bc_hi, bytes;
3486 int i_write, do_write = (qc->tf.flags & ATA_TFLAG_WRITE) ? 1 : 0;
3488 ap->ops->tf_read(ap, &qc->tf);
3489 ireason = qc->tf.nsect;
3490 bc_lo = qc->tf.lbam;
3491 bc_hi = qc->tf.lbah;
3492 bytes = (bc_hi << 8) | bc_lo;
3494 /* shall be cleared to zero, indicating xfer of data */
3495 if (ireason & (1 << 0))
3496 goto err_out;
3498 /* make sure transfer direction matches expected */
3499 i_write = ((ireason & (1 << 1)) == 0) ? 1 : 0;
3500 if (do_write != i_write)
3501 goto err_out;
3503 __atapi_pio_bytes(qc, bytes);
3505 return;
3507 err_out:
3508 printk(KERN_INFO "ata%u: dev %u: ATAPI check failed\n",
3509 ap->id, dev->devno);
3510 qc->err_mask |= AC_ERR_HSM;
3511 ap->hsm_task_state = HSM_ST_ERR;
3515 * ata_pio_block - start PIO on a block
3516 * @ap: the target ata_port
3518 * LOCKING:
3519 * None. (executing in kernel thread context)
3522 static void ata_pio_block(struct ata_port *ap)
3524 struct ata_queued_cmd *qc;
3525 u8 status;
3528 * This is purely heuristic. This is a fast path.
3529 * Sometimes when we enter, BSY will be cleared in
3530 * a chk-status or two. If not, the drive is probably seeking
3531 * or something. Snooze for a couple msecs, then
3532 * chk-status again. If still busy, fall back to
3533 * HSM_ST_POLL state.
3535 status = ata_busy_wait(ap, ATA_BUSY, 5);
3536 if (status & ATA_BUSY) {
3537 msleep(2);
3538 status = ata_busy_wait(ap, ATA_BUSY, 10);
3539 if (status & ATA_BUSY) {
3540 ap->hsm_task_state = HSM_ST_POLL;
3541 ap->pio_task_timeout = jiffies + ATA_TMOUT_PIO;
3542 return;
3546 qc = ata_qc_from_tag(ap, ap->active_tag);
3547 WARN_ON(qc == NULL);
3549 /* check error */
3550 if (status & (ATA_ERR | ATA_DF)) {
3551 qc->err_mask |= AC_ERR_DEV;
3552 ap->hsm_task_state = HSM_ST_ERR;
3553 return;
3556 /* transfer data if any */
3557 if (is_atapi_taskfile(&qc->tf)) {
3558 /* DRQ=0 means no more data to transfer */
3559 if ((status & ATA_DRQ) == 0) {
3560 ap->hsm_task_state = HSM_ST_LAST;
3561 return;
3564 atapi_pio_bytes(qc);
3565 } else {
3566 /* handle BSY=0, DRQ=0 as error */
3567 if ((status & ATA_DRQ) == 0) {
3568 qc->err_mask |= AC_ERR_HSM;
3569 ap->hsm_task_state = HSM_ST_ERR;
3570 return;
3573 ata_pio_sector(qc);
3577 static void ata_pio_error(struct ata_port *ap)
3579 struct ata_queued_cmd *qc;
3581 qc = ata_qc_from_tag(ap, ap->active_tag);
3582 WARN_ON(qc == NULL);
3584 if (qc->tf.command != ATA_CMD_PACKET)
3585 printk(KERN_WARNING "ata%u: PIO error\n", ap->id);
3587 /* make sure qc->err_mask is available to
3588 * know what's wrong and recover
3590 WARN_ON(qc->err_mask == 0);
3592 ap->hsm_task_state = HSM_ST_IDLE;
3594 ata_poll_qc_complete(qc);
3597 static void ata_pio_task(void *_data)
3599 struct ata_port *ap = _data;
3600 unsigned long timeout;
3601 int qc_completed;
3603 fsm_start:
3604 timeout = 0;
3605 qc_completed = 0;
3607 switch (ap->hsm_task_state) {
3608 case HSM_ST_IDLE:
3609 return;
3611 case HSM_ST:
3612 ata_pio_block(ap);
3613 break;
3615 case HSM_ST_LAST:
3616 qc_completed = ata_pio_complete(ap);
3617 break;
3619 case HSM_ST_POLL:
3620 case HSM_ST_LAST_POLL:
3621 timeout = ata_pio_poll(ap);
3622 break;
3624 case HSM_ST_TMOUT:
3625 case HSM_ST_ERR:
3626 ata_pio_error(ap);
3627 return;
3630 if (timeout)
3631 ata_port_queue_task(ap, ata_pio_task, ap, timeout);
3632 else if (!qc_completed)
3633 goto fsm_start;
3637 * atapi_packet_task - Write CDB bytes to hardware
3638 * @_data: Port to which ATAPI device is attached.
3640 * When device has indicated its readiness to accept
3641 * a CDB, this function is called. Send the CDB.
3642 * If DMA is to be performed, exit immediately.
3643 * Otherwise, we are in polling mode, so poll
3644 * status under operation succeeds or fails.
3646 * LOCKING:
3647 * Kernel thread context (may sleep)
3650 static void atapi_packet_task(void *_data)
3652 struct ata_port *ap = _data;
3653 struct ata_queued_cmd *qc;
3654 u8 status;
3656 qc = ata_qc_from_tag(ap, ap->active_tag);
3657 WARN_ON(qc == NULL);
3658 WARN_ON(!(qc->flags & ATA_QCFLAG_ACTIVE));
3660 /* sleep-wait for BSY to clear */
3661 DPRINTK("busy wait\n");
3662 if (ata_busy_sleep(ap, ATA_TMOUT_CDB_QUICK, ATA_TMOUT_CDB)) {
3663 qc->err_mask |= AC_ERR_TIMEOUT;
3664 goto err_out;
3667 /* make sure DRQ is set */
3668 status = ata_chk_status(ap);
3669 if ((status & (ATA_BUSY | ATA_DRQ)) != ATA_DRQ) {
3670 qc->err_mask |= AC_ERR_HSM;
3671 goto err_out;
3674 /* send SCSI cdb */
3675 DPRINTK("send cdb\n");
3676 WARN_ON(qc->dev->cdb_len < 12);
3678 if (qc->tf.protocol == ATA_PROT_ATAPI_DMA ||
3679 qc->tf.protocol == ATA_PROT_ATAPI_NODATA) {
3680 unsigned long flags;
3682 /* Once we're done issuing command and kicking bmdma,
3683 * irq handler takes over. To not lose irq, we need
3684 * to clear NOINTR flag before sending cdb, but
3685 * interrupt handler shouldn't be invoked before we're
3686 * finished. Hence, the following locking.
3688 spin_lock_irqsave(&ap->host_set->lock, flags);
3689 ap->flags &= ~ATA_FLAG_NOINTR;
3690 ata_data_xfer(ap, qc->cdb, qc->dev->cdb_len, 1);
3691 if (qc->tf.protocol == ATA_PROT_ATAPI_DMA)
3692 ap->ops->bmdma_start(qc); /* initiate bmdma */
3693 spin_unlock_irqrestore(&ap->host_set->lock, flags);
3694 } else {
3695 ata_data_xfer(ap, qc->cdb, qc->dev->cdb_len, 1);
3697 /* PIO commands are handled by polling */
3698 ap->hsm_task_state = HSM_ST;
3699 ata_port_queue_task(ap, ata_pio_task, ap, 0);
3702 return;
3704 err_out:
3705 ata_poll_qc_complete(qc);
3709 * ata_qc_timeout - Handle timeout of queued command
3710 * @qc: Command that timed out
3712 * Some part of the kernel (currently, only the SCSI layer)
3713 * has noticed that the active command on port @ap has not
3714 * completed after a specified length of time. Handle this
3715 * condition by disabling DMA (if necessary) and completing
3716 * transactions, with error if necessary.
3718 * This also handles the case of the "lost interrupt", where
3719 * for some reason (possibly hardware bug, possibly driver bug)
3720 * an interrupt was not delivered to the driver, even though the
3721 * transaction completed successfully.
3723 * LOCKING:
3724 * Inherited from SCSI layer (none, can sleep)
3727 static void ata_qc_timeout(struct ata_queued_cmd *qc)
3729 struct ata_port *ap = qc->ap;
3730 struct ata_host_set *host_set = ap->host_set;
3731 u8 host_stat = 0, drv_stat;
3732 unsigned long flags;
3734 DPRINTK("ENTER\n");
3736 ap->hsm_task_state = HSM_ST_IDLE;
3738 spin_lock_irqsave(&host_set->lock, flags);
3740 switch (qc->tf.protocol) {
3742 case ATA_PROT_DMA:
3743 case ATA_PROT_ATAPI_DMA:
3744 host_stat = ap->ops->bmdma_status(ap);
3746 /* before we do anything else, clear DMA-Start bit */
3747 ap->ops->bmdma_stop(qc);
3749 /* fall through */
3751 default:
3752 ata_altstatus(ap);
3753 drv_stat = ata_chk_status(ap);
3755 /* ack bmdma irq events */
3756 ap->ops->irq_clear(ap);
3758 printk(KERN_ERR "ata%u: command 0x%x timeout, stat 0x%x host_stat 0x%x\n",
3759 ap->id, qc->tf.command, drv_stat, host_stat);
3761 /* complete taskfile transaction */
3762 qc->err_mask |= ac_err_mask(drv_stat);
3763 break;
3766 spin_unlock_irqrestore(&host_set->lock, flags);
3768 ata_eh_qc_complete(qc);
3770 DPRINTK("EXIT\n");
3774 * ata_eng_timeout - Handle timeout of queued command
3775 * @ap: Port on which timed-out command is active
3777 * Some part of the kernel (currently, only the SCSI layer)
3778 * has noticed that the active command on port @ap has not
3779 * completed after a specified length of time. Handle this
3780 * condition by disabling DMA (if necessary) and completing
3781 * transactions, with error if necessary.
3783 * This also handles the case of the "lost interrupt", where
3784 * for some reason (possibly hardware bug, possibly driver bug)
3785 * an interrupt was not delivered to the driver, even though the
3786 * transaction completed successfully.
3788 * LOCKING:
3789 * Inherited from SCSI layer (none, can sleep)
3792 void ata_eng_timeout(struct ata_port *ap)
3794 DPRINTK("ENTER\n");
3796 ata_qc_timeout(ata_qc_from_tag(ap, ap->active_tag));
3798 DPRINTK("EXIT\n");
3802 * ata_qc_new - Request an available ATA command, for queueing
3803 * @ap: Port associated with device @dev
3804 * @dev: Device from whom we request an available command structure
3806 * LOCKING:
3807 * None.
3810 static struct ata_queued_cmd *ata_qc_new(struct ata_port *ap)
3812 struct ata_queued_cmd *qc = NULL;
3813 unsigned int i;
3815 for (i = 0; i < ATA_MAX_QUEUE; i++)
3816 if (!test_and_set_bit(i, &ap->qactive)) {
3817 qc = ata_qc_from_tag(ap, i);
3818 break;
3821 if (qc)
3822 qc->tag = i;
3824 return qc;
3828 * ata_qc_new_init - Request an available ATA command, and initialize it
3829 * @ap: Port associated with device @dev
3830 * @dev: Device from whom we request an available command structure
3832 * LOCKING:
3833 * None.
3836 struct ata_queued_cmd *ata_qc_new_init(struct ata_port *ap,
3837 struct ata_device *dev)
3839 struct ata_queued_cmd *qc;
3841 qc = ata_qc_new(ap);
3842 if (qc) {
3843 qc->scsicmd = NULL;
3844 qc->ap = ap;
3845 qc->dev = dev;
3847 ata_qc_reinit(qc);
3850 return qc;
3854 * ata_qc_free - free unused ata_queued_cmd
3855 * @qc: Command to complete
3857 * Designed to free unused ata_queued_cmd object
3858 * in case something prevents using it.
3860 * LOCKING:
3861 * spin_lock_irqsave(host_set lock)
3863 void ata_qc_free(struct ata_queued_cmd *qc)
3865 struct ata_port *ap = qc->ap;
3866 unsigned int tag;
3868 WARN_ON(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
3870 qc->flags = 0;
3871 tag = qc->tag;
3872 if (likely(ata_tag_valid(tag))) {
3873 if (tag == ap->active_tag)
3874 ap->active_tag = ATA_TAG_POISON;
3875 qc->tag = ATA_TAG_POISON;
3876 clear_bit(tag, &ap->qactive);
3880 void __ata_qc_complete(struct ata_queued_cmd *qc)
3882 WARN_ON(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
3883 WARN_ON(!(qc->flags & ATA_QCFLAG_ACTIVE));
3885 if (likely(qc->flags & ATA_QCFLAG_DMAMAP))
3886 ata_sg_clean(qc);
3888 /* atapi: mark qc as inactive to prevent the interrupt handler
3889 * from completing the command twice later, before the error handler
3890 * is called. (when rc != 0 and atapi request sense is needed)
3892 qc->flags &= ~ATA_QCFLAG_ACTIVE;
3894 /* call completion callback */
3895 qc->complete_fn(qc);
3898 static inline int ata_should_dma_map(struct ata_queued_cmd *qc)
3900 struct ata_port *ap = qc->ap;
3902 switch (qc->tf.protocol) {
3903 case ATA_PROT_DMA:
3904 case ATA_PROT_ATAPI_DMA:
3905 return 1;
3907 case ATA_PROT_ATAPI:
3908 case ATA_PROT_PIO:
3909 case ATA_PROT_PIO_MULT:
3910 if (ap->flags & ATA_FLAG_PIO_DMA)
3911 return 1;
3913 /* fall through */
3915 default:
3916 return 0;
3919 /* never reached */
3923 * ata_qc_issue - issue taskfile to device
3924 * @qc: command to issue to device
3926 * Prepare an ATA command to submission to device.
3927 * This includes mapping the data into a DMA-able
3928 * area, filling in the S/G table, and finally
3929 * writing the taskfile to hardware, starting the command.
3931 * LOCKING:
3932 * spin_lock_irqsave(host_set lock)
3934 * RETURNS:
3935 * Zero on success, AC_ERR_* mask on failure
3938 unsigned int ata_qc_issue(struct ata_queued_cmd *qc)
3940 struct ata_port *ap = qc->ap;
3942 if (ata_should_dma_map(qc)) {
3943 if (qc->flags & ATA_QCFLAG_SG) {
3944 if (ata_sg_setup(qc))
3945 goto sg_err;
3946 } else if (qc->flags & ATA_QCFLAG_SINGLE) {
3947 if (ata_sg_setup_one(qc))
3948 goto sg_err;
3950 } else {
3951 qc->flags &= ~ATA_QCFLAG_DMAMAP;
3954 ap->ops->qc_prep(qc);
3956 qc->ap->active_tag = qc->tag;
3957 qc->flags |= ATA_QCFLAG_ACTIVE;
3959 return ap->ops->qc_issue(qc);
3961 sg_err:
3962 qc->flags &= ~ATA_QCFLAG_DMAMAP;
3963 return AC_ERR_SYSTEM;
3968 * ata_qc_issue_prot - issue taskfile to device in proto-dependent manner
3969 * @qc: command to issue to device
3971 * Using various libata functions and hooks, this function
3972 * starts an ATA command. ATA commands are grouped into
3973 * classes called "protocols", and issuing each type of protocol
3974 * is slightly different.
3976 * May be used as the qc_issue() entry in ata_port_operations.
3978 * LOCKING:
3979 * spin_lock_irqsave(host_set lock)
3981 * RETURNS:
3982 * Zero on success, AC_ERR_* mask on failure
3985 unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc)
3987 struct ata_port *ap = qc->ap;
3989 ata_dev_select(ap, qc->dev->devno, 1, 0);
3991 switch (qc->tf.protocol) {
3992 case ATA_PROT_NODATA:
3993 ata_tf_to_host(ap, &qc->tf);
3994 break;
3996 case ATA_PROT_DMA:
3997 ap->ops->tf_load(ap, &qc->tf); /* load tf registers */
3998 ap->ops->bmdma_setup(qc); /* set up bmdma */
3999 ap->ops->bmdma_start(qc); /* initiate bmdma */
4000 break;
4002 case ATA_PROT_PIO: /* load tf registers, initiate polling pio */
4003 ata_qc_set_polling(qc);
4004 ata_tf_to_host(ap, &qc->tf);
4005 ap->hsm_task_state = HSM_ST;
4006 ata_port_queue_task(ap, ata_pio_task, ap, 0);
4007 break;
4009 case ATA_PROT_ATAPI:
4010 ata_qc_set_polling(qc);
4011 ata_tf_to_host(ap, &qc->tf);
4012 ata_port_queue_task(ap, atapi_packet_task, ap, 0);
4013 break;
4015 case ATA_PROT_ATAPI_NODATA:
4016 ap->flags |= ATA_FLAG_NOINTR;
4017 ata_tf_to_host(ap, &qc->tf);
4018 ata_port_queue_task(ap, atapi_packet_task, ap, 0);
4019 break;
4021 case ATA_PROT_ATAPI_DMA:
4022 ap->flags |= ATA_FLAG_NOINTR;
4023 ap->ops->tf_load(ap, &qc->tf); /* load tf registers */
4024 ap->ops->bmdma_setup(qc); /* set up bmdma */
4025 ata_port_queue_task(ap, atapi_packet_task, ap, 0);
4026 break;
4028 default:
4029 WARN_ON(1);
4030 return AC_ERR_SYSTEM;
4033 return 0;
4037 * ata_bmdma_setup_mmio - Set up PCI IDE BMDMA transaction
4038 * @qc: Info associated with this ATA transaction.
4040 * LOCKING:
4041 * spin_lock_irqsave(host_set lock)
4044 static void ata_bmdma_setup_mmio (struct ata_queued_cmd *qc)
4046 struct ata_port *ap = qc->ap;
4047 unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
4048 u8 dmactl;
4049 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
4051 /* load PRD table addr. */
4052 mb(); /* make sure PRD table writes are visible to controller */
4053 writel(ap->prd_dma, mmio + ATA_DMA_TABLE_OFS);
4055 /* specify data direction, triple-check start bit is clear */
4056 dmactl = readb(mmio + ATA_DMA_CMD);
4057 dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
4058 if (!rw)
4059 dmactl |= ATA_DMA_WR;
4060 writeb(dmactl, mmio + ATA_DMA_CMD);
4062 /* issue r/w command */
4063 ap->ops->exec_command(ap, &qc->tf);
4067 * ata_bmdma_start_mmio - Start a PCI IDE BMDMA transaction
4068 * @qc: Info associated with this ATA transaction.
4070 * LOCKING:
4071 * spin_lock_irqsave(host_set lock)
4074 static void ata_bmdma_start_mmio (struct ata_queued_cmd *qc)
4076 struct ata_port *ap = qc->ap;
4077 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
4078 u8 dmactl;
4080 /* start host DMA transaction */
4081 dmactl = readb(mmio + ATA_DMA_CMD);
4082 writeb(dmactl | ATA_DMA_START, mmio + ATA_DMA_CMD);
4084 /* Strictly, one may wish to issue a readb() here, to
4085 * flush the mmio write. However, control also passes
4086 * to the hardware at this point, and it will interrupt
4087 * us when we are to resume control. So, in effect,
4088 * we don't care when the mmio write flushes.
4089 * Further, a read of the DMA status register _immediately_
4090 * following the write may not be what certain flaky hardware
4091 * is expected, so I think it is best to not add a readb()
4092 * without first all the MMIO ATA cards/mobos.
4093 * Or maybe I'm just being paranoid.
4098 * ata_bmdma_setup_pio - Set up PCI IDE BMDMA transaction (PIO)
4099 * @qc: Info associated with this ATA transaction.
4101 * LOCKING:
4102 * spin_lock_irqsave(host_set lock)
4105 static void ata_bmdma_setup_pio (struct ata_queued_cmd *qc)
4107 struct ata_port *ap = qc->ap;
4108 unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
4109 u8 dmactl;
4111 /* load PRD table addr. */
4112 outl(ap->prd_dma, ap->ioaddr.bmdma_addr + ATA_DMA_TABLE_OFS);
4114 /* specify data direction, triple-check start bit is clear */
4115 dmactl = inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
4116 dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
4117 if (!rw)
4118 dmactl |= ATA_DMA_WR;
4119 outb(dmactl, ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
4121 /* issue r/w command */
4122 ap->ops->exec_command(ap, &qc->tf);
4126 * ata_bmdma_start_pio - Start a PCI IDE BMDMA transaction (PIO)
4127 * @qc: Info associated with this ATA transaction.
4129 * LOCKING:
4130 * spin_lock_irqsave(host_set lock)
4133 static void ata_bmdma_start_pio (struct ata_queued_cmd *qc)
4135 struct ata_port *ap = qc->ap;
4136 u8 dmactl;
4138 /* start host DMA transaction */
4139 dmactl = inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
4140 outb(dmactl | ATA_DMA_START,
4141 ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
4146 * ata_bmdma_start - Start a PCI IDE BMDMA transaction
4147 * @qc: Info associated with this ATA transaction.
4149 * Writes the ATA_DMA_START flag to the DMA command register.
4151 * May be used as the bmdma_start() entry in ata_port_operations.
4153 * LOCKING:
4154 * spin_lock_irqsave(host_set lock)
4156 void ata_bmdma_start(struct ata_queued_cmd *qc)
4158 if (qc->ap->flags & ATA_FLAG_MMIO)
4159 ata_bmdma_start_mmio(qc);
4160 else
4161 ata_bmdma_start_pio(qc);
4166 * ata_bmdma_setup - Set up PCI IDE BMDMA transaction
4167 * @qc: Info associated with this ATA transaction.
4169 * Writes address of PRD table to device's PRD Table Address
4170 * register, sets the DMA control register, and calls
4171 * ops->exec_command() to start the transfer.
4173 * May be used as the bmdma_setup() entry in ata_port_operations.
4175 * LOCKING:
4176 * spin_lock_irqsave(host_set lock)
4178 void ata_bmdma_setup(struct ata_queued_cmd *qc)
4180 if (qc->ap->flags & ATA_FLAG_MMIO)
4181 ata_bmdma_setup_mmio(qc);
4182 else
4183 ata_bmdma_setup_pio(qc);
4188 * ata_bmdma_irq_clear - Clear PCI IDE BMDMA interrupt.
4189 * @ap: Port associated with this ATA transaction.
4191 * Clear interrupt and error flags in DMA status register.
4193 * May be used as the irq_clear() entry in ata_port_operations.
4195 * LOCKING:
4196 * spin_lock_irqsave(host_set lock)
4199 void ata_bmdma_irq_clear(struct ata_port *ap)
4201 if (ap->flags & ATA_FLAG_MMIO) {
4202 void __iomem *mmio = ((void __iomem *) ap->ioaddr.bmdma_addr) + ATA_DMA_STATUS;
4203 writeb(readb(mmio), mmio);
4204 } else {
4205 unsigned long addr = ap->ioaddr.bmdma_addr + ATA_DMA_STATUS;
4206 outb(inb(addr), addr);
4213 * ata_bmdma_status - Read PCI IDE BMDMA status
4214 * @ap: Port associated with this ATA transaction.
4216 * Read and return BMDMA status register.
4218 * May be used as the bmdma_status() entry in ata_port_operations.
4220 * LOCKING:
4221 * spin_lock_irqsave(host_set lock)
4224 u8 ata_bmdma_status(struct ata_port *ap)
4226 u8 host_stat;
4227 if (ap->flags & ATA_FLAG_MMIO) {
4228 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
4229 host_stat = readb(mmio + ATA_DMA_STATUS);
4230 } else
4231 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
4232 return host_stat;
4237 * ata_bmdma_stop - Stop PCI IDE BMDMA transfer
4238 * @qc: Command we are ending DMA for
4240 * Clears the ATA_DMA_START flag in the dma control register
4242 * May be used as the bmdma_stop() entry in ata_port_operations.
4244 * LOCKING:
4245 * spin_lock_irqsave(host_set lock)
4248 void ata_bmdma_stop(struct ata_queued_cmd *qc)
4250 struct ata_port *ap = qc->ap;
4251 if (ap->flags & ATA_FLAG_MMIO) {
4252 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
4254 /* clear start/stop bit */
4255 writeb(readb(mmio + ATA_DMA_CMD) & ~ATA_DMA_START,
4256 mmio + ATA_DMA_CMD);
4257 } else {
4258 /* clear start/stop bit */
4259 outb(inb(ap->ioaddr.bmdma_addr + ATA_DMA_CMD) & ~ATA_DMA_START,
4260 ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
4263 /* one-PIO-cycle guaranteed wait, per spec, for HDMA1:0 transition */
4264 ata_altstatus(ap); /* dummy read */
4268 * ata_host_intr - Handle host interrupt for given (port, task)
4269 * @ap: Port on which interrupt arrived (possibly...)
4270 * @qc: Taskfile currently active in engine
4272 * Handle host interrupt for given queued command. Currently,
4273 * only DMA interrupts are handled. All other commands are
4274 * handled via polling with interrupts disabled (nIEN bit).
4276 * LOCKING:
4277 * spin_lock_irqsave(host_set lock)
4279 * RETURNS:
4280 * One if interrupt was handled, zero if not (shared irq).
4283 inline unsigned int ata_host_intr (struct ata_port *ap,
4284 struct ata_queued_cmd *qc)
4286 u8 status, host_stat;
4288 switch (qc->tf.protocol) {
4290 case ATA_PROT_DMA:
4291 case ATA_PROT_ATAPI_DMA:
4292 case ATA_PROT_ATAPI:
4293 /* check status of DMA engine */
4294 host_stat = ap->ops->bmdma_status(ap);
4295 VPRINTK("ata%u: host_stat 0x%X\n", ap->id, host_stat);
4297 /* if it's not our irq... */
4298 if (!(host_stat & ATA_DMA_INTR))
4299 goto idle_irq;
4301 /* before we do anything else, clear DMA-Start bit */
4302 ap->ops->bmdma_stop(qc);
4304 /* fall through */
4306 case ATA_PROT_ATAPI_NODATA:
4307 case ATA_PROT_NODATA:
4308 /* check altstatus */
4309 status = ata_altstatus(ap);
4310 if (status & ATA_BUSY)
4311 goto idle_irq;
4313 /* check main status, clearing INTRQ */
4314 status = ata_chk_status(ap);
4315 if (unlikely(status & ATA_BUSY))
4316 goto idle_irq;
4317 DPRINTK("ata%u: protocol %d (dev_stat 0x%X)\n",
4318 ap->id, qc->tf.protocol, status);
4320 /* ack bmdma irq events */
4321 ap->ops->irq_clear(ap);
4323 /* complete taskfile transaction */
4324 qc->err_mask |= ac_err_mask(status);
4325 ata_qc_complete(qc);
4326 break;
4328 default:
4329 goto idle_irq;
4332 return 1; /* irq handled */
4334 idle_irq:
4335 ap->stats.idle_irq++;
4337 #ifdef ATA_IRQ_TRAP
4338 if ((ap->stats.idle_irq % 1000) == 0) {
4339 handled = 1;
4340 ata_irq_ack(ap, 0); /* debug trap */
4341 printk(KERN_WARNING "ata%d: irq trap\n", ap->id);
4343 #endif
4344 return 0; /* irq not handled */
4348 * ata_interrupt - Default ATA host interrupt handler
4349 * @irq: irq line (unused)
4350 * @dev_instance: pointer to our ata_host_set information structure
4351 * @regs: unused
4353 * Default interrupt handler for PCI IDE devices. Calls
4354 * ata_host_intr() for each port that is not disabled.
4356 * LOCKING:
4357 * Obtains host_set lock during operation.
4359 * RETURNS:
4360 * IRQ_NONE or IRQ_HANDLED.
4363 irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
4365 struct ata_host_set *host_set = dev_instance;
4366 unsigned int i;
4367 unsigned int handled = 0;
4368 unsigned long flags;
4370 /* TODO: make _irqsave conditional on x86 PCI IDE legacy mode */
4371 spin_lock_irqsave(&host_set->lock, flags);
4373 for (i = 0; i < host_set->n_ports; i++) {
4374 struct ata_port *ap;
4376 ap = host_set->ports[i];
4377 if (ap &&
4378 !(ap->flags & (ATA_FLAG_PORT_DISABLED | ATA_FLAG_NOINTR))) {
4379 struct ata_queued_cmd *qc;
4381 qc = ata_qc_from_tag(ap, ap->active_tag);
4382 if (qc && (!(qc->tf.ctl & ATA_NIEN)) &&
4383 (qc->flags & ATA_QCFLAG_ACTIVE))
4384 handled |= ata_host_intr(ap, qc);
4388 spin_unlock_irqrestore(&host_set->lock, flags);
4390 return IRQ_RETVAL(handled);
4395 * Execute a 'simple' command, that only consists of the opcode 'cmd' itself,
4396 * without filling any other registers
4398 static int ata_do_simple_cmd(struct ata_port *ap, struct ata_device *dev,
4399 u8 cmd)
4401 struct ata_taskfile tf;
4402 int err;
4404 ata_tf_init(ap, &tf, dev->devno);
4406 tf.command = cmd;
4407 tf.flags |= ATA_TFLAG_DEVICE;
4408 tf.protocol = ATA_PROT_NODATA;
4410 err = ata_exec_internal(ap, dev, &tf, DMA_NONE, NULL, 0);
4411 if (err)
4412 printk(KERN_ERR "%s: ata command failed: %d\n",
4413 __FUNCTION__, err);
4415 return err;
4418 static int ata_flush_cache(struct ata_port *ap, struct ata_device *dev)
4420 u8 cmd;
4422 if (!ata_try_flush_cache(dev))
4423 return 0;
4425 if (ata_id_has_flush_ext(dev->id))
4426 cmd = ATA_CMD_FLUSH_EXT;
4427 else
4428 cmd = ATA_CMD_FLUSH;
4430 return ata_do_simple_cmd(ap, dev, cmd);
4433 static int ata_standby_drive(struct ata_port *ap, struct ata_device *dev)
4435 return ata_do_simple_cmd(ap, dev, ATA_CMD_STANDBYNOW1);
4438 static int ata_start_drive(struct ata_port *ap, struct ata_device *dev)
4440 return ata_do_simple_cmd(ap, dev, ATA_CMD_IDLEIMMEDIATE);
4444 * ata_device_resume - wakeup a previously suspended devices
4445 * @ap: port the device is connected to
4446 * @dev: the device to resume
4448 * Kick the drive back into action, by sending it an idle immediate
4449 * command and making sure its transfer mode matches between drive
4450 * and host.
4453 int ata_device_resume(struct ata_port *ap, struct ata_device *dev)
4455 if (ap->flags & ATA_FLAG_SUSPENDED) {
4456 ap->flags &= ~ATA_FLAG_SUSPENDED;
4457 ata_set_mode(ap);
4459 if (!ata_dev_present(dev))
4460 return 0;
4461 if (dev->class == ATA_DEV_ATA)
4462 ata_start_drive(ap, dev);
4464 return 0;
4468 * ata_device_suspend - prepare a device for suspend
4469 * @ap: port the device is connected to
4470 * @dev: the device to suspend
4472 * Flush the cache on the drive, if appropriate, then issue a
4473 * standbynow command.
4475 int ata_device_suspend(struct ata_port *ap, struct ata_device *dev)
4477 if (!ata_dev_present(dev))
4478 return 0;
4479 if (dev->class == ATA_DEV_ATA)
4480 ata_flush_cache(ap, dev);
4482 ata_standby_drive(ap, dev);
4483 ap->flags |= ATA_FLAG_SUSPENDED;
4484 return 0;
4488 * ata_port_start - Set port up for dma.
4489 * @ap: Port to initialize
4491 * Called just after data structures for each port are
4492 * initialized. Allocates space for PRD table.
4494 * May be used as the port_start() entry in ata_port_operations.
4496 * LOCKING:
4497 * Inherited from caller.
4500 int ata_port_start (struct ata_port *ap)
4502 struct device *dev = ap->host_set->dev;
4503 int rc;
4505 ap->prd = dma_alloc_coherent(dev, ATA_PRD_TBL_SZ, &ap->prd_dma, GFP_KERNEL);
4506 if (!ap->prd)
4507 return -ENOMEM;
4509 rc = ata_pad_alloc(ap, dev);
4510 if (rc) {
4511 dma_free_coherent(dev, ATA_PRD_TBL_SZ, ap->prd, ap->prd_dma);
4512 return rc;
4515 DPRINTK("prd alloc, virt %p, dma %llx\n", ap->prd, (unsigned long long) ap->prd_dma);
4517 return 0;
4522 * ata_port_stop - Undo ata_port_start()
4523 * @ap: Port to shut down
4525 * Frees the PRD table.
4527 * May be used as the port_stop() entry in ata_port_operations.
4529 * LOCKING:
4530 * Inherited from caller.
4533 void ata_port_stop (struct ata_port *ap)
4535 struct device *dev = ap->host_set->dev;
4537 dma_free_coherent(dev, ATA_PRD_TBL_SZ, ap->prd, ap->prd_dma);
4538 ata_pad_free(ap, dev);
4541 void ata_host_stop (struct ata_host_set *host_set)
4543 if (host_set->mmio_base)
4544 iounmap(host_set->mmio_base);
4549 * ata_host_remove - Unregister SCSI host structure with upper layers
4550 * @ap: Port to unregister
4551 * @do_unregister: 1 if we fully unregister, 0 to just stop the port
4553 * LOCKING:
4554 * Inherited from caller.
4557 static void ata_host_remove(struct ata_port *ap, unsigned int do_unregister)
4559 struct Scsi_Host *sh = ap->host;
4561 DPRINTK("ENTER\n");
4563 if (do_unregister)
4564 scsi_remove_host(sh);
4566 ap->ops->port_stop(ap);
4570 * ata_host_init - Initialize an ata_port structure
4571 * @ap: Structure to initialize
4572 * @host: associated SCSI mid-layer structure
4573 * @host_set: Collection of hosts to which @ap belongs
4574 * @ent: Probe information provided by low-level driver
4575 * @port_no: Port number associated with this ata_port
4577 * Initialize a new ata_port structure, and its associated
4578 * scsi_host.
4580 * LOCKING:
4581 * Inherited from caller.
4584 static void ata_host_init(struct ata_port *ap, struct Scsi_Host *host,
4585 struct ata_host_set *host_set,
4586 const struct ata_probe_ent *ent, unsigned int port_no)
4588 unsigned int i;
4590 host->max_id = 16;
4591 host->max_lun = 1;
4592 host->max_channel = 1;
4593 host->unique_id = ata_unique_id++;
4594 host->max_cmd_len = 12;
4596 ap->flags = ATA_FLAG_PORT_DISABLED;
4597 ap->id = host->unique_id;
4598 ap->host = host;
4599 ap->ctl = ATA_DEVCTL_OBS;
4600 ap->host_set = host_set;
4601 ap->port_no = port_no;
4602 ap->hard_port_no =
4603 ent->legacy_mode ? ent->hard_port_no : port_no;
4604 ap->pio_mask = ent->pio_mask;
4605 ap->mwdma_mask = ent->mwdma_mask;
4606 ap->udma_mask = ent->udma_mask;
4607 ap->flags |= ent->host_flags;
4608 ap->ops = ent->port_ops;
4609 ap->cbl = ATA_CBL_NONE;
4610 ap->active_tag = ATA_TAG_POISON;
4611 ap->last_ctl = 0xFF;
4613 INIT_WORK(&ap->port_task, NULL, NULL);
4614 INIT_LIST_HEAD(&ap->eh_done_q);
4616 for (i = 0; i < ATA_MAX_DEVICES; i++)
4617 ap->device[i].devno = i;
4619 #ifdef ATA_IRQ_TRAP
4620 ap->stats.unhandled_irq = 1;
4621 ap->stats.idle_irq = 1;
4622 #endif
4624 memcpy(&ap->ioaddr, &ent->port[port_no], sizeof(struct ata_ioports));
4628 * ata_host_add - Attach low-level ATA driver to system
4629 * @ent: Information provided by low-level driver
4630 * @host_set: Collections of ports to which we add
4631 * @port_no: Port number associated with this host
4633 * Attach low-level ATA driver to system.
4635 * LOCKING:
4636 * PCI/etc. bus probe sem.
4638 * RETURNS:
4639 * New ata_port on success, for NULL on error.
4642 static struct ata_port * ata_host_add(const struct ata_probe_ent *ent,
4643 struct ata_host_set *host_set,
4644 unsigned int port_no)
4646 struct Scsi_Host *host;
4647 struct ata_port *ap;
4648 int rc;
4650 DPRINTK("ENTER\n");
4651 host = scsi_host_alloc(ent->sht, sizeof(struct ata_port));
4652 if (!host)
4653 return NULL;
4655 ap = (struct ata_port *) &host->hostdata[0];
4657 ata_host_init(ap, host, host_set, ent, port_no);
4659 rc = ap->ops->port_start(ap);
4660 if (rc)
4661 goto err_out;
4663 return ap;
4665 err_out:
4666 scsi_host_put(host);
4667 return NULL;
4671 * ata_device_add - Register hardware device with ATA and SCSI layers
4672 * @ent: Probe information describing hardware device to be registered
4674 * This function processes the information provided in the probe
4675 * information struct @ent, allocates the necessary ATA and SCSI
4676 * host information structures, initializes them, and registers
4677 * everything with requisite kernel subsystems.
4679 * This function requests irqs, probes the ATA bus, and probes
4680 * the SCSI bus.
4682 * LOCKING:
4683 * PCI/etc. bus probe sem.
4685 * RETURNS:
4686 * Number of ports registered. Zero on error (no ports registered).
4689 int ata_device_add(const struct ata_probe_ent *ent)
4691 unsigned int count = 0, i;
4692 struct device *dev = ent->dev;
4693 struct ata_host_set *host_set;
4695 DPRINTK("ENTER\n");
4696 /* alloc a container for our list of ATA ports (buses) */
4697 host_set = kzalloc(sizeof(struct ata_host_set) +
4698 (ent->n_ports * sizeof(void *)), GFP_KERNEL);
4699 if (!host_set)
4700 return 0;
4701 spin_lock_init(&host_set->lock);
4703 host_set->dev = dev;
4704 host_set->n_ports = ent->n_ports;
4705 host_set->irq = ent->irq;
4706 host_set->mmio_base = ent->mmio_base;
4707 host_set->private_data = ent->private_data;
4708 host_set->ops = ent->port_ops;
4710 /* register each port bound to this device */
4711 for (i = 0; i < ent->n_ports; i++) {
4712 struct ata_port *ap;
4713 unsigned long xfer_mode_mask;
4715 ap = ata_host_add(ent, host_set, i);
4716 if (!ap)
4717 goto err_out;
4719 host_set->ports[i] = ap;
4720 xfer_mode_mask =(ap->udma_mask << ATA_SHIFT_UDMA) |
4721 (ap->mwdma_mask << ATA_SHIFT_MWDMA) |
4722 (ap->pio_mask << ATA_SHIFT_PIO);
4724 /* print per-port info to dmesg */
4725 printk(KERN_INFO "ata%u: %cATA max %s cmd 0x%lX ctl 0x%lX "
4726 "bmdma 0x%lX irq %lu\n",
4727 ap->id,
4728 ap->flags & ATA_FLAG_SATA ? 'S' : 'P',
4729 ata_mode_string(xfer_mode_mask),
4730 ap->ioaddr.cmd_addr,
4731 ap->ioaddr.ctl_addr,
4732 ap->ioaddr.bmdma_addr,
4733 ent->irq);
4735 ata_chk_status(ap);
4736 host_set->ops->irq_clear(ap);
4737 count++;
4740 if (!count)
4741 goto err_free_ret;
4743 /* obtain irq, that is shared between channels */
4744 if (request_irq(ent->irq, ent->port_ops->irq_handler, ent->irq_flags,
4745 DRV_NAME, host_set))
4746 goto err_out;
4748 /* perform each probe synchronously */
4749 DPRINTK("probe begin\n");
4750 for (i = 0; i < count; i++) {
4751 struct ata_port *ap;
4752 int rc;
4754 ap = host_set->ports[i];
4756 DPRINTK("ata%u: bus probe begin\n", ap->id);
4757 rc = ata_bus_probe(ap);
4758 DPRINTK("ata%u: bus probe end\n", ap->id);
4760 if (rc) {
4761 /* FIXME: do something useful here?
4762 * Current libata behavior will
4763 * tear down everything when
4764 * the module is removed
4765 * or the h/w is unplugged.
4769 rc = scsi_add_host(ap->host, dev);
4770 if (rc) {
4771 printk(KERN_ERR "ata%u: scsi_add_host failed\n",
4772 ap->id);
4773 /* FIXME: do something useful here */
4774 /* FIXME: handle unconditional calls to
4775 * scsi_scan_host and ata_host_remove, below,
4776 * at the very least
4781 /* probes are done, now scan each port's disk(s) */
4782 DPRINTK("host probe begin\n");
4783 for (i = 0; i < count; i++) {
4784 struct ata_port *ap = host_set->ports[i];
4786 ata_scsi_scan_host(ap);
4789 dev_set_drvdata(dev, host_set);
4791 VPRINTK("EXIT, returning %u\n", ent->n_ports);
4792 return ent->n_ports; /* success */
4794 err_out:
4795 for (i = 0; i < count; i++) {
4796 ata_host_remove(host_set->ports[i], 1);
4797 scsi_host_put(host_set->ports[i]->host);
4799 err_free_ret:
4800 kfree(host_set);
4801 VPRINTK("EXIT, returning 0\n");
4802 return 0;
4806 * ata_host_set_remove - PCI layer callback for device removal
4807 * @host_set: ATA host set that was removed
4809 * Unregister all objects associated with this host set. Free those
4810 * objects.
4812 * LOCKING:
4813 * Inherited from calling layer (may sleep).
4816 void ata_host_set_remove(struct ata_host_set *host_set)
4818 struct ata_port *ap;
4819 unsigned int i;
4821 for (i = 0; i < host_set->n_ports; i++) {
4822 ap = host_set->ports[i];
4823 scsi_remove_host(ap->host);
4826 free_irq(host_set->irq, host_set);
4828 for (i = 0; i < host_set->n_ports; i++) {
4829 ap = host_set->ports[i];
4831 ata_scsi_release(ap->host);
4833 if ((ap->flags & ATA_FLAG_NO_LEGACY) == 0) {
4834 struct ata_ioports *ioaddr = &ap->ioaddr;
4836 if (ioaddr->cmd_addr == 0x1f0)
4837 release_region(0x1f0, 8);
4838 else if (ioaddr->cmd_addr == 0x170)
4839 release_region(0x170, 8);
4842 scsi_host_put(ap->host);
4845 if (host_set->ops->host_stop)
4846 host_set->ops->host_stop(host_set);
4848 kfree(host_set);
4852 * ata_scsi_release - SCSI layer callback hook for host unload
4853 * @host: libata host to be unloaded
4855 * Performs all duties necessary to shut down a libata port...
4856 * Kill port kthread, disable port, and release resources.
4858 * LOCKING:
4859 * Inherited from SCSI layer.
4861 * RETURNS:
4862 * One.
4865 int ata_scsi_release(struct Scsi_Host *host)
4867 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
4868 int i;
4870 DPRINTK("ENTER\n");
4872 ap->ops->port_disable(ap);
4873 ata_host_remove(ap, 0);
4874 for (i = 0; i < ATA_MAX_DEVICES; i++)
4875 kfree(ap->device[i].id);
4877 DPRINTK("EXIT\n");
4878 return 1;
4882 * ata_std_ports - initialize ioaddr with standard port offsets.
4883 * @ioaddr: IO address structure to be initialized
4885 * Utility function which initializes data_addr, error_addr,
4886 * feature_addr, nsect_addr, lbal_addr, lbam_addr, lbah_addr,
4887 * device_addr, status_addr, and command_addr to standard offsets
4888 * relative to cmd_addr.
4890 * Does not set ctl_addr, altstatus_addr, bmdma_addr, or scr_addr.
4893 void ata_std_ports(struct ata_ioports *ioaddr)
4895 ioaddr->data_addr = ioaddr->cmd_addr + ATA_REG_DATA;
4896 ioaddr->error_addr = ioaddr->cmd_addr + ATA_REG_ERR;
4897 ioaddr->feature_addr = ioaddr->cmd_addr + ATA_REG_FEATURE;
4898 ioaddr->nsect_addr = ioaddr->cmd_addr + ATA_REG_NSECT;
4899 ioaddr->lbal_addr = ioaddr->cmd_addr + ATA_REG_LBAL;
4900 ioaddr->lbam_addr = ioaddr->cmd_addr + ATA_REG_LBAM;
4901 ioaddr->lbah_addr = ioaddr->cmd_addr + ATA_REG_LBAH;
4902 ioaddr->device_addr = ioaddr->cmd_addr + ATA_REG_DEVICE;
4903 ioaddr->status_addr = ioaddr->cmd_addr + ATA_REG_STATUS;
4904 ioaddr->command_addr = ioaddr->cmd_addr + ATA_REG_CMD;
4908 #ifdef CONFIG_PCI
4910 void ata_pci_host_stop (struct ata_host_set *host_set)
4912 struct pci_dev *pdev = to_pci_dev(host_set->dev);
4914 pci_iounmap(pdev, host_set->mmio_base);
4918 * ata_pci_remove_one - PCI layer callback for device removal
4919 * @pdev: PCI device that was removed
4921 * PCI layer indicates to libata via this hook that
4922 * hot-unplug or module unload event has occurred.
4923 * Handle this by unregistering all objects associated
4924 * with this PCI device. Free those objects. Then finally
4925 * release PCI resources and disable device.
4927 * LOCKING:
4928 * Inherited from PCI layer (may sleep).
4931 void ata_pci_remove_one (struct pci_dev *pdev)
4933 struct device *dev = pci_dev_to_dev(pdev);
4934 struct ata_host_set *host_set = dev_get_drvdata(dev);
4936 ata_host_set_remove(host_set);
4937 pci_release_regions(pdev);
4938 pci_disable_device(pdev);
4939 dev_set_drvdata(dev, NULL);
4942 /* move to PCI subsystem */
4943 int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits)
4945 unsigned long tmp = 0;
4947 switch (bits->width) {
4948 case 1: {
4949 u8 tmp8 = 0;
4950 pci_read_config_byte(pdev, bits->reg, &tmp8);
4951 tmp = tmp8;
4952 break;
4954 case 2: {
4955 u16 tmp16 = 0;
4956 pci_read_config_word(pdev, bits->reg, &tmp16);
4957 tmp = tmp16;
4958 break;
4960 case 4: {
4961 u32 tmp32 = 0;
4962 pci_read_config_dword(pdev, bits->reg, &tmp32);
4963 tmp = tmp32;
4964 break;
4967 default:
4968 return -EINVAL;
4971 tmp &= bits->mask;
4973 return (tmp == bits->val) ? 1 : 0;
4976 int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state)
4978 pci_save_state(pdev);
4979 pci_disable_device(pdev);
4980 pci_set_power_state(pdev, PCI_D3hot);
4981 return 0;
4984 int ata_pci_device_resume(struct pci_dev *pdev)
4986 pci_set_power_state(pdev, PCI_D0);
4987 pci_restore_state(pdev);
4988 pci_enable_device(pdev);
4989 pci_set_master(pdev);
4990 return 0;
4992 #endif /* CONFIG_PCI */
4995 static int __init ata_init(void)
4997 ata_wq = create_workqueue("ata");
4998 if (!ata_wq)
4999 return -ENOMEM;
5001 printk(KERN_DEBUG "libata version " DRV_VERSION " loaded.\n");
5002 return 0;
5005 static void __exit ata_exit(void)
5007 destroy_workqueue(ata_wq);
5010 module_init(ata_init);
5011 module_exit(ata_exit);
5013 static unsigned long ratelimit_time;
5014 static spinlock_t ata_ratelimit_lock = SPIN_LOCK_UNLOCKED;
5016 int ata_ratelimit(void)
5018 int rc;
5019 unsigned long flags;
5021 spin_lock_irqsave(&ata_ratelimit_lock, flags);
5023 if (time_after(jiffies, ratelimit_time)) {
5024 rc = 1;
5025 ratelimit_time = jiffies + (HZ/5);
5026 } else
5027 rc = 0;
5029 spin_unlock_irqrestore(&ata_ratelimit_lock, flags);
5031 return rc;
5035 * libata is essentially a library of internal helper functions for
5036 * low-level ATA host controller drivers. As such, the API/ABI is
5037 * likely to change as new drivers are added and updated.
5038 * Do not depend on ABI/API stability.
5041 EXPORT_SYMBOL_GPL(ata_std_bios_param);
5042 EXPORT_SYMBOL_GPL(ata_std_ports);
5043 EXPORT_SYMBOL_GPL(ata_device_add);
5044 EXPORT_SYMBOL_GPL(ata_host_set_remove);
5045 EXPORT_SYMBOL_GPL(ata_sg_init);
5046 EXPORT_SYMBOL_GPL(ata_sg_init_one);
5047 EXPORT_SYMBOL_GPL(__ata_qc_complete);
5048 EXPORT_SYMBOL_GPL(ata_qc_issue_prot);
5049 EXPORT_SYMBOL_GPL(ata_eng_timeout);
5050 EXPORT_SYMBOL_GPL(ata_tf_load);
5051 EXPORT_SYMBOL_GPL(ata_tf_read);
5052 EXPORT_SYMBOL_GPL(ata_noop_dev_select);
5053 EXPORT_SYMBOL_GPL(ata_std_dev_select);
5054 EXPORT_SYMBOL_GPL(ata_tf_to_fis);
5055 EXPORT_SYMBOL_GPL(ata_tf_from_fis);
5056 EXPORT_SYMBOL_GPL(ata_check_status);
5057 EXPORT_SYMBOL_GPL(ata_altstatus);
5058 EXPORT_SYMBOL_GPL(ata_exec_command);
5059 EXPORT_SYMBOL_GPL(ata_port_start);
5060 EXPORT_SYMBOL_GPL(ata_port_stop);
5061 EXPORT_SYMBOL_GPL(ata_host_stop);
5062 EXPORT_SYMBOL_GPL(ata_interrupt);
5063 EXPORT_SYMBOL_GPL(ata_qc_prep);
5064 EXPORT_SYMBOL_GPL(ata_bmdma_setup);
5065 EXPORT_SYMBOL_GPL(ata_bmdma_start);
5066 EXPORT_SYMBOL_GPL(ata_bmdma_irq_clear);
5067 EXPORT_SYMBOL_GPL(ata_bmdma_status);
5068 EXPORT_SYMBOL_GPL(ata_bmdma_stop);
5069 EXPORT_SYMBOL_GPL(ata_port_probe);
5070 EXPORT_SYMBOL_GPL(sata_phy_reset);
5071 EXPORT_SYMBOL_GPL(__sata_phy_reset);
5072 EXPORT_SYMBOL_GPL(ata_bus_reset);
5073 EXPORT_SYMBOL_GPL(ata_std_probeinit);
5074 EXPORT_SYMBOL_GPL(ata_std_softreset);
5075 EXPORT_SYMBOL_GPL(sata_std_hardreset);
5076 EXPORT_SYMBOL_GPL(ata_std_postreset);
5077 EXPORT_SYMBOL_GPL(ata_std_probe_reset);
5078 EXPORT_SYMBOL_GPL(ata_drive_probe_reset);
5079 EXPORT_SYMBOL_GPL(ata_dev_revalidate);
5080 EXPORT_SYMBOL_GPL(ata_port_disable);
5081 EXPORT_SYMBOL_GPL(ata_ratelimit);
5082 EXPORT_SYMBOL_GPL(ata_busy_sleep);
5083 EXPORT_SYMBOL_GPL(ata_port_queue_task);
5084 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
5085 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
5086 EXPORT_SYMBOL_GPL(ata_scsi_timed_out);
5087 EXPORT_SYMBOL_GPL(ata_scsi_error);
5088 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
5089 EXPORT_SYMBOL_GPL(ata_scsi_release);
5090 EXPORT_SYMBOL_GPL(ata_host_intr);
5091 EXPORT_SYMBOL_GPL(ata_dev_classify);
5092 EXPORT_SYMBOL_GPL(ata_id_string);
5093 EXPORT_SYMBOL_GPL(ata_id_c_string);
5094 EXPORT_SYMBOL_GPL(ata_scsi_simulate);
5095 EXPORT_SYMBOL_GPL(ata_eh_qc_complete);
5096 EXPORT_SYMBOL_GPL(ata_eh_qc_retry);
5098 EXPORT_SYMBOL_GPL(ata_pio_need_iordy);
5099 EXPORT_SYMBOL_GPL(ata_timing_compute);
5100 EXPORT_SYMBOL_GPL(ata_timing_merge);
5102 #ifdef CONFIG_PCI
5103 EXPORT_SYMBOL_GPL(pci_test_config_bits);
5104 EXPORT_SYMBOL_GPL(ata_pci_host_stop);
5105 EXPORT_SYMBOL_GPL(ata_pci_init_native_mode);
5106 EXPORT_SYMBOL_GPL(ata_pci_init_one);
5107 EXPORT_SYMBOL_GPL(ata_pci_remove_one);
5108 EXPORT_SYMBOL_GPL(ata_pci_device_suspend);
5109 EXPORT_SYMBOL_GPL(ata_pci_device_resume);
5110 #endif /* CONFIG_PCI */
5112 EXPORT_SYMBOL_GPL(ata_device_suspend);
5113 EXPORT_SYMBOL_GPL(ata_device_resume);
5114 EXPORT_SYMBOL_GPL(ata_scsi_device_suspend);
5115 EXPORT_SYMBOL_GPL(ata_scsi_device_resume);