529af9fbed5328aa3c96a2031b04979877b002ed
[linux-2.6.git] / include / linux / libata.h
1 /*
2  *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
3  *  Copyright 2003-2005 Jeff Garzik
4  *
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2, or (at your option)
9  *  any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; see the file COPYING.  If not, write to
18  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19  *
20  *
21  *  libata documentation is available via 'make {ps|pdf}docs',
22  *  as Documentation/DocBook/libata.*
23  *
24  */
25
26 #ifndef __LINUX_LIBATA_H__
27 #define __LINUX_LIBATA_H__
28
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
31 #include <linux/pci.h>
32 #include <linux/dma-mapping.h>
33 #include <asm/scatterlist.h>
34 #include <linux/io.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
38 #include <linux/acpi.h>
39
40 /*
41  * Define if arch has non-standard setup.  This is a _PCI_ standard
42  * not a legacy or ISA standard.
43  */
44 #ifdef CONFIG_ATA_NONSTANDARD
45 #include <asm/libata-portmap.h>
46 #else
47 #include <asm-generic/libata-portmap.h>
48 #endif
49
50 /*
51  * compile-time options: to be removed as soon as all the drivers are
52  * converted to the new debugging mechanism
53  */
54 #undef ATA_DEBUG                /* debugging output */
55 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
56 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
57 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
58
59
60 /* note: prints function name for you */
61 #ifdef ATA_DEBUG
62 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63 #ifdef ATA_VERBOSE_DEBUG
64 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
65 #else
66 #define VPRINTK(fmt, args...)
67 #endif  /* ATA_VERBOSE_DEBUG */
68 #else
69 #define DPRINTK(fmt, args...)
70 #define VPRINTK(fmt, args...)
71 #endif  /* ATA_DEBUG */
72
73 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
74
75 /* NEW: debug levels */
76 #define HAVE_LIBATA_MSG 1
77
78 enum {
79         ATA_MSG_DRV     = 0x0001,
80         ATA_MSG_INFO    = 0x0002,
81         ATA_MSG_PROBE   = 0x0004,
82         ATA_MSG_WARN    = 0x0008,
83         ATA_MSG_MALLOC  = 0x0010,
84         ATA_MSG_CTL     = 0x0020,
85         ATA_MSG_INTR    = 0x0040,
86         ATA_MSG_ERR     = 0x0080,
87 };
88
89 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
90 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
91 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
92 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
93 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
95 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
96 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
97
98 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
99 {
100         if (dval < 0 || dval >= (sizeof(u32) * 8))
101                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
102         if (!dval)
103                 return 0;
104         return (1 << dval) - 1;
105 }
106
107 /* defines only for the constants which don't work well as enums */
108 #define ATA_TAG_POISON          0xfafbfcfdU
109
110 /* move to PCI layer? */
111 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
112 {
113         return &pdev->dev;
114 }
115
116 enum {
117         /* various global constants */
118         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
119         LIBATA_DUMB_MAX_PRD     = ATA_MAX_PRD / 4,      /* Worst case */
120         ATA_MAX_PORTS           = 8,
121         ATA_DEF_QUEUE           = 1,
122         /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
123         ATA_MAX_QUEUE           = 32,
124         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE - 1,
125         ATA_MAX_BUS             = 2,
126         ATA_DEF_BUSY_WAIT       = 10000,
127         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
128
129         ATA_SHT_EMULATED        = 1,
130         ATA_SHT_CMD_PER_LUN     = 1,
131         ATA_SHT_THIS_ID         = -1,
132         ATA_SHT_USE_CLUSTERING  = 1,
133
134         /* struct ata_device stuff */
135         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
136         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
137         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
138         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
139         ATA_DFLAG_FLUSH_EXT     = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
140         ATA_DFLAG_ACPI_PENDING  = (1 << 5), /* ACPI resume action pending */
141         ATA_DFLAG_ACPI_FAILED   = (1 << 6), /* ACPI on devcfg has failed */
142         ATA_DFLAG_AN            = (1 << 7), /* AN configured */
143         ATA_DFLAG_CFG_MASK      = (1 << 12) - 1,
144
145         ATA_DFLAG_PIO           = (1 << 12), /* device limited to PIO mode */
146         ATA_DFLAG_NCQ_OFF       = (1 << 13), /* device limited to non-NCQ mode */
147         ATA_DFLAG_SPUNDOWN      = (1 << 14), /* XXX: for spindown_compat */
148         ATA_DFLAG_INIT_MASK     = (1 << 16) - 1,
149
150         ATA_DFLAG_DETACH        = (1 << 16),
151         ATA_DFLAG_DETACHED      = (1 << 17),
152
153         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
154         ATA_DEV_ATA             = 1,    /* ATA device */
155         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
156         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
157         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
158         ATA_DEV_PMP             = 5,    /* SATA port multiplier */
159         ATA_DEV_PMP_UNSUP       = 6,    /* SATA port multiplier (unsupported) */
160         ATA_DEV_SEMB            = 7,    /* SEMB */
161         ATA_DEV_SEMB_UNSUP      = 8,    /* SEMB (unsupported) */
162         ATA_DEV_NONE            = 9,    /* no device */
163
164         /* struct ata_link flags */
165         ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */
166         ATA_LFLAG_SKIP_D2H_BSY  = (1 << 1), /* can't wait for the first D2H
167                                              * Register FIS clearing BSY */
168         ATA_LFLAG_NO_SRST       = (1 << 2), /* avoid softreset */
169         ATA_LFLAG_ASSUME_ATA    = (1 << 3), /* assume ATA class */
170         ATA_LFLAG_ASSUME_SEMB   = (1 << 4), /* assume SEMB class */
171         ATA_LFLAG_ASSUME_CLASS  = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
172         ATA_LFLAG_NO_RETRY      = (1 << 5), /* don't retry this link */
173         ATA_LFLAG_DISABLED      = (1 << 6), /* link is disabled */
174
175         /* struct ata_port flags */
176         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
177                                             /* (doesn't imply presence) */
178         ATA_FLAG_SATA           = (1 << 1),
179         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
180         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
181         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
182         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
183         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
184         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
185         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
186         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
187                                              * doesn't handle PIO interrupts */
188         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
189         ATA_FLAG_DEBUGMSG       = (1 << 13),
190         ATA_FLAG_IGN_SIMPLEX    = (1 << 15), /* ignore SIMPLEX */
191         ATA_FLAG_NO_IORDY       = (1 << 16), /* controller lacks iordy */
192         ATA_FLAG_ACPI_SATA      = (1 << 17), /* need native SATA ACPI layout */
193         ATA_FLAG_AN             = (1 << 18), /* controller supports AN */
194         ATA_FLAG_PMP            = (1 << 19), /* controller supports PMP */
195
196         /* The following flag belongs to ap->pflags but is kept in
197          * ap->flags because it's referenced in many LLDs and will be
198          * removed in not-too-distant future.
199          */
200         ATA_FLAG_DISABLED       = (1 << 23), /* port is disabled, ignore it */
201
202         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
203
204         /* struct ata_port pflags */
205         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
206         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
207         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
208         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
209         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
210         ATA_PFLAG_UNLOADING     = (1 << 5), /* module is unloading */
211         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
212         ATA_PFLAG_INITIALIZING  = (1 << 7), /* being initialized, don't touch */
213         ATA_PFLAG_RESETTING     = (1 << 8), /* reset in progress */
214
215         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
216         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
217         ATA_PFLAG_GTM_VALID     = (1 << 19), /* acpi_gtm data valid */
218
219         /* struct ata_queued_cmd flags */
220         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
221         ATA_QCFLAG_SG           = (1 << 1), /* have s/g table? */
222         ATA_QCFLAG_SINGLE       = (1 << 2), /* no s/g, just a single buffer */
223         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
224         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
225         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
226         ATA_QCFLAG_CLEAR_EXCL   = (1 << 5), /* clear excl_link on completion */
227
228         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
229         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
230         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
231
232         /* host set flags */
233         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
234         ATA_HOST_STARTED        = (1 << 1),     /* Host started */
235
236         /* bits 24:31 of host->flags are reserved for LLD specific flags */
237
238         /* various lengths of time */
239         ATA_TMOUT_BOOT          = 30 * HZ,      /* heuristic */
240         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* heuristic */
241         ATA_TMOUT_INTERNAL      = 30 * HZ,
242         ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
243
244         /* ATA bus states */
245         BUS_UNKNOWN             = 0,
246         BUS_DMA                 = 1,
247         BUS_IDLE                = 2,
248         BUS_NOINTR              = 3,
249         BUS_NODATA              = 4,
250         BUS_TIMER               = 5,
251         BUS_PIO                 = 6,
252         BUS_EDD                 = 7,
253         BUS_IDENTIFY            = 8,
254         BUS_PACKET              = 9,
255
256         /* SATA port states */
257         PORT_UNKNOWN            = 0,
258         PORT_ENABLED            = 1,
259         PORT_DISABLED           = 2,
260
261         /* encoding various smaller bitmaps into a single
262          * unsigned int bitmap
263          */
264         ATA_BITS_PIO            = 7,
265         ATA_BITS_MWDMA          = 5,
266         ATA_BITS_UDMA           = 8,
267
268         ATA_SHIFT_PIO           = 0,
269         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_BITS_PIO,
270         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
271
272         ATA_MASK_PIO            = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
273         ATA_MASK_MWDMA          = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
274         ATA_MASK_UDMA           = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
275
276         /* size of buffer to pad xfers ending on unaligned boundaries */
277         ATA_DMA_PAD_SZ          = 4,
278         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
279
280         /* ering size */
281         ATA_ERING_SIZE          = 32,
282
283         /* return values for ->qc_defer */
284         ATA_DEFER_LINK          = 1,
285         ATA_DEFER_PORT          = 2,
286
287         /* desc_len for ata_eh_info and context */
288         ATA_EH_DESC_LEN         = 80,
289
290         /* reset / recovery action types */
291         ATA_EH_REVALIDATE       = (1 << 0),
292         ATA_EH_SOFTRESET        = (1 << 1),
293         ATA_EH_HARDRESET        = (1 << 2),
294         ATA_EH_ENABLE_LINK      = (1 << 3),
295
296         ATA_EH_RESET_MASK       = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
297         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE,
298
299         /* ata_eh_info->flags */
300         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
301         ATA_EHI_RESUME_LINK     = (1 << 1),  /* resume link (reset modifier) */
302         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
303         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
304
305         ATA_EHI_DID_SOFTRESET   = (1 << 16), /* already soft-reset this port */
306         ATA_EHI_DID_HARDRESET   = (1 << 17), /* already soft-reset this port */
307         ATA_EHI_PRINTINFO       = (1 << 18), /* print configuration info */
308         ATA_EHI_SETMODE         = (1 << 19), /* configure transfer mode */
309         ATA_EHI_POST_SETMODE    = (1 << 20), /* revaildating after setmode */
310
311         ATA_EHI_DID_RESET       = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
312         ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
313
314         /* max tries if error condition is still set after ->error_handler */
315         ATA_EH_MAX_TRIES        = 5,
316
317         /* how hard are we gonna try to probe/recover devices */
318         ATA_PROBE_MAX_TRIES     = 3,
319         ATA_EH_DEV_TRIES        = 3,
320         ATA_EH_PMP_TRIES        = 5,
321         ATA_EH_PMP_LINK_TRIES   = 3,
322
323         SATA_PMP_SCR_TIMEOUT    = 250,
324
325         /* Horkage types. May be set by libata or controller on drives
326            (some horkage may be drive/controller pair dependant */
327
328         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
329         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
330         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
331         ATA_HORKAGE_MAX_SEC_128 = (1 << 3),     /* Limit max sects to 128 */
332         ATA_HORKAGE_BROKEN_HPA  = (1 << 4),     /* Broken HPA */
333         ATA_HORKAGE_SKIP_PM     = (1 << 5),     /* Skip PM operations */
334         ATA_HORKAGE_HPA_SIZE    = (1 << 6),     /* native size off by one */
335
336          /* DMA mask for user DMA control: User visible values; DO NOT 
337             renumber */
338         ATA_DMA_MASK_ATA        = (1 << 0),     /* DMA on ATA Disk */
339         ATA_DMA_MASK_ATAPI      = (1 << 1),     /* DMA on ATAPI */
340         ATA_DMA_MASK_CFA        = (1 << 2),     /* DMA on CF Card */
341 };
342
343 enum hsm_task_states {
344         HSM_ST_IDLE,            /* no command on going */
345         HSM_ST_FIRST,           /* (waiting the device to)
346                                    write CDB or first data block */
347         HSM_ST,                 /* (waiting the device to) transfer data */
348         HSM_ST_LAST,            /* (waiting the device to) complete command */
349         HSM_ST_ERR,             /* error */
350 };
351
352 enum ata_completion_errors {
353         AC_ERR_DEV              = (1 << 0), /* device reported error */
354         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
355         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
356         AC_ERR_MEDIA            = (1 << 3), /* media error */
357         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
358         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
359         AC_ERR_SYSTEM           = (1 << 6), /* system error */
360         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
361         AC_ERR_OTHER            = (1 << 8), /* unknown */
362         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
363         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
364 };
365
366 /* forward declarations */
367 struct scsi_device;
368 struct ata_port_operations;
369 struct ata_port;
370 struct ata_link;
371 struct ata_queued_cmd;
372
373 /* typedefs */
374 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
375 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
376 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
377                               unsigned long deadline);
378 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
379
380 struct ata_ioports {
381         void __iomem            *cmd_addr;
382         void __iomem            *data_addr;
383         void __iomem            *error_addr;
384         void __iomem            *feature_addr;
385         void __iomem            *nsect_addr;
386         void __iomem            *lbal_addr;
387         void __iomem            *lbam_addr;
388         void __iomem            *lbah_addr;
389         void __iomem            *device_addr;
390         void __iomem            *status_addr;
391         void __iomem            *command_addr;
392         void __iomem            *altstatus_addr;
393         void __iomem            *ctl_addr;
394         void __iomem            *bmdma_addr;
395         void __iomem            *scr_addr;
396 };
397
398 struct ata_host {
399         spinlock_t              lock;
400         struct device           *dev;
401         void __iomem * const    *iomap;
402         unsigned int            n_ports;
403         void                    *private_data;
404         const struct ata_port_operations *ops;
405         unsigned long           flags;
406 #ifdef CONFIG_ATA_ACPI
407         acpi_handle             acpi_handle;
408 #endif
409         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
410         struct ata_port         *ports[0];
411 };
412
413 struct ata_queued_cmd {
414         struct ata_port         *ap;
415         struct ata_device       *dev;
416
417         struct scsi_cmnd        *scsicmd;
418         void                    (*scsidone)(struct scsi_cmnd *);
419
420         struct ata_taskfile     tf;
421         u8                      cdb[ATAPI_CDB_LEN];
422
423         unsigned long           flags;          /* ATA_QCFLAG_xxx */
424         unsigned int            tag;
425         unsigned int            n_elem;
426         unsigned int            orig_n_elem;
427
428         int                     dma_dir;
429
430         unsigned int            pad_len;
431         unsigned int            sect_size;
432
433         unsigned int            nbytes;
434         unsigned int            curbytes;
435
436         unsigned int            cursg;
437         unsigned int            cursg_ofs;
438
439         struct scatterlist      sgent;
440         struct scatterlist      pad_sgent;
441         void                    *buf_virt;
442
443         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
444         struct scatterlist      *__sg;
445
446         unsigned int            err_mask;
447         struct ata_taskfile     result_tf;
448         ata_qc_cb_t             complete_fn;
449
450         void                    *private_data;
451         void                    *lldd_task;
452 };
453
454 struct ata_port_stats {
455         unsigned long           unhandled_irq;
456         unsigned long           idle_irq;
457         unsigned long           rw_reqbuf;
458 };
459
460 struct ata_ering_entry {
461         int                     is_io;
462         unsigned int            err_mask;
463         u64                     timestamp;
464 };
465
466 struct ata_ering {
467         int                     cursor;
468         struct ata_ering_entry  ring[ATA_ERING_SIZE];
469 };
470
471 struct ata_device {
472         struct ata_link         *link;
473         unsigned int            devno;          /* 0 or 1 */
474         unsigned long           flags;          /* ATA_DFLAG_xxx */
475         unsigned int            horkage;        /* List of broken features */
476         struct scsi_device      *sdev;          /* attached SCSI device */
477 #ifdef CONFIG_ATA_ACPI
478         acpi_handle             acpi_handle;
479 #endif
480         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
481         u64                     n_sectors;      /* size of device, if ATA */
482         unsigned int            class;          /* ATA_DEV_xxx */
483
484         union {
485                 u16             id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
486                 u32             gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
487         };
488
489         u8                      pio_mode;
490         u8                      dma_mode;
491         u8                      xfer_mode;
492         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
493
494         unsigned int            multi_count;    /* sectors count for
495                                                    READ/WRITE MULTIPLE */
496         unsigned int            max_sectors;    /* per-device max sectors */
497         unsigned int            cdb_len;
498
499         /* per-dev xfer mask */
500         unsigned int            pio_mask;
501         unsigned int            mwdma_mask;
502         unsigned int            udma_mask;
503
504         /* for CHS addressing */
505         u16                     cylinders;      /* Number of cylinders */
506         u16                     heads;          /* Number of heads */
507         u16                     sectors;        /* Number of sectors per track */
508
509         /* error history */
510         struct ata_ering        ering;
511         int                     spdn_cnt;
512 };
513
514 /* Offset into struct ata_device.  Fields above it are maintained
515  * acress device init.  Fields below are zeroed.
516  */
517 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
518
519 struct ata_eh_info {
520         struct ata_device       *dev;           /* offending device */
521         u32                     serror;         /* SError from LLDD */
522         unsigned int            err_mask;       /* port-wide err_mask */
523         unsigned int            action;         /* ATA_EH_* action mask */
524         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
525         unsigned int            flags;          /* ATA_EHI_* flags */
526
527         unsigned int            probe_mask;
528
529         char                    desc[ATA_EH_DESC_LEN];
530         int                     desc_len;
531 };
532
533 struct ata_eh_context {
534         struct ata_eh_info      i;
535         int                     tries[ATA_MAX_DEVICES];
536         unsigned int            classes[ATA_MAX_DEVICES];
537         unsigned int            did_probe_mask;
538 };
539
540 struct ata_acpi_drive
541 {
542         u32 pio;
543         u32 dma;
544 } __packed;
545
546 struct ata_acpi_gtm {
547         struct ata_acpi_drive drive[2];
548         u32 flags;
549 } __packed;
550
551 struct ata_link {
552         struct ata_port         *ap;
553         int                     pmp;            /* port multiplier port # */
554
555         unsigned int            active_tag;     /* active tag on this link */
556         u32                     sactive;        /* active NCQ commands */
557
558         unsigned int            flags;          /* ATA_LFLAG_xxx */
559
560         unsigned int            hw_sata_spd_limit;
561         unsigned int            sata_spd_limit;
562         unsigned int            sata_spd;       /* current SATA PHY speed */
563
564         /* record runtime error info, protected by host_set lock */
565         struct ata_eh_info      eh_info;
566         /* EH context */
567         struct ata_eh_context   eh_context;
568
569         struct ata_device       device[ATA_MAX_DEVICES];
570 };
571
572 struct ata_port {
573         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
574         const struct ata_port_operations *ops;
575         spinlock_t              *lock;
576         unsigned long           flags;  /* ATA_FLAG_xxx */
577         unsigned int            pflags; /* ATA_PFLAG_xxx */
578         unsigned int            print_id; /* user visible unique port ID */
579         unsigned int            port_no; /* 0 based port no. inside the host */
580
581         struct ata_prd          *prd;    /* our SG list */
582         dma_addr_t              prd_dma; /* and its DMA mapping */
583
584         void                    *pad;   /* array of DMA pad buffers */
585         dma_addr_t              pad_dma;
586
587         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
588
589         u8                      ctl;    /* cache of ATA control register */
590         u8                      last_ctl;       /* Cache last written value */
591         unsigned int            pio_mask;
592         unsigned int            mwdma_mask;
593         unsigned int            udma_mask;
594         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
595
596         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
597         unsigned long           qc_allocated;
598         unsigned int            qc_active;
599         int                     nr_active_links; /* #links with active qcs */
600
601         struct ata_link         link;   /* host default link */
602
603         int                     nr_pmp_links;   /* nr of available PMP links */
604         struct ata_link         *pmp_link;      /* array of PMP links */
605         struct ata_link         *excl_link;     /* for PMP qc exclusion */
606
607         struct ata_port_stats   stats;
608         struct ata_host         *host;
609         struct device           *dev;
610
611         void                    *port_task_data;
612         struct delayed_work     port_task;
613         struct delayed_work     hotplug_task;
614         struct work_struct      scsi_rescan_task;
615
616         unsigned int            hsm_task_state;
617
618         u32                     msg_enable;
619         struct list_head        eh_done_q;
620         wait_queue_head_t       eh_wait_q;
621         int                     eh_tries;
622
623         pm_message_t            pm_mesg;
624         int                     *pm_result;
625
626         struct timer_list       fastdrain_timer;
627         unsigned long           fastdrain_cnt;
628
629         void                    *private_data;
630
631 #ifdef CONFIG_ATA_ACPI
632         acpi_handle             acpi_handle;
633         struct ata_acpi_gtm     acpi_gtm;
634 #endif
635         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
636 };
637
638 struct ata_port_operations {
639         void (*dev_config) (struct ata_device *);
640
641         void (*set_piomode) (struct ata_port *, struct ata_device *);
642         void (*set_dmamode) (struct ata_port *, struct ata_device *);
643         unsigned long (*mode_filter) (struct ata_device *, unsigned long);
644
645         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
646         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
647
648         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
649         u8   (*check_status)(struct ata_port *ap);
650         u8   (*check_altstatus)(struct ata_port *ap);
651         void (*dev_select)(struct ata_port *ap, unsigned int device);
652
653         void (*phy_reset) (struct ata_port *ap); /* obsolete */
654         int  (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
655
656         int (*cable_detect) (struct ata_port *ap);
657
658         int  (*check_atapi_dma) (struct ata_queued_cmd *qc);
659
660         void (*bmdma_setup) (struct ata_queued_cmd *qc);
661         void (*bmdma_start) (struct ata_queued_cmd *qc);
662
663         void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
664
665         int (*qc_defer) (struct ata_queued_cmd *qc);
666         void (*qc_prep) (struct ata_queued_cmd *qc);
667         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
668
669         /* port multiplier */
670         void (*pmp_attach) (struct ata_port *ap);
671         void (*pmp_detach) (struct ata_port *ap);
672         int (*pmp_read) (struct ata_device *dev, int pmp, int reg, u32 *r_val);
673         int (*pmp_write) (struct ata_device *dev, int pmp, int reg, u32 val);
674
675         /* Error handlers.  ->error_handler overrides ->eng_timeout and
676          * indicates that new-style EH is in place.
677          */
678         void (*eng_timeout) (struct ata_port *ap); /* obsolete */
679
680         void (*freeze) (struct ata_port *ap);
681         void (*thaw) (struct ata_port *ap);
682         void (*error_handler) (struct ata_port *ap);
683         void (*post_internal_cmd) (struct ata_queued_cmd *qc);
684
685         irq_handler_t irq_handler;
686         void (*irq_clear) (struct ata_port *);
687         u8 (*irq_on) (struct ata_port *);
688
689         int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
690         int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
691
692         int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
693         int (*port_resume) (struct ata_port *ap);
694
695         int (*port_start) (struct ata_port *ap);
696         void (*port_stop) (struct ata_port *ap);
697
698         void (*host_stop) (struct ata_host *host);
699
700         void (*bmdma_stop) (struct ata_queued_cmd *qc);
701         u8   (*bmdma_status) (struct ata_port *ap);
702 };
703
704 struct ata_port_info {
705         struct scsi_host_template       *sht;
706         unsigned long           flags;
707         unsigned long           link_flags;
708         unsigned long           pio_mask;
709         unsigned long           mwdma_mask;
710         unsigned long           udma_mask;
711         const struct ata_port_operations *port_ops;
712         irq_handler_t           irq_handler;
713         void                    *private_data;
714 };
715
716 struct ata_timing {
717         unsigned short mode;            /* ATA mode */
718         unsigned short setup;           /* t1 */
719         unsigned short act8b;           /* t2 for 8-bit I/O */
720         unsigned short rec8b;           /* t2i for 8-bit I/O */
721         unsigned short cyc8b;           /* t0 for 8-bit I/O */
722         unsigned short active;          /* t2 or tD */
723         unsigned short recover;         /* t2i or tK */
724         unsigned short cycle;           /* t0 */
725         unsigned short udma;            /* t2CYCTYP/2 */
726 };
727
728 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
729
730 extern const unsigned long sata_deb_timing_normal[];
731 extern const unsigned long sata_deb_timing_hotplug[];
732 extern const unsigned long sata_deb_timing_long[];
733
734 extern const struct ata_port_operations ata_dummy_port_ops;
735 extern const struct ata_port_info ata_dummy_port_info;
736
737 static inline const unsigned long *
738 sata_ehc_deb_timing(struct ata_eh_context *ehc)
739 {
740         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
741                 return sata_deb_timing_hotplug;
742         else
743                 return sata_deb_timing_normal;
744 }
745
746 static inline int ata_port_is_dummy(struct ata_port *ap)
747 {
748         return ap->ops == &ata_dummy_port_ops;
749 }
750
751 extern void sata_print_link_status(struct ata_link *link);
752 extern void ata_port_probe(struct ata_port *);
753 extern void __sata_phy_reset(struct ata_port *ap);
754 extern void sata_phy_reset(struct ata_port *ap);
755 extern void ata_bus_reset(struct ata_port *ap);
756 extern int sata_set_spd(struct ata_link *link);
757 extern int sata_link_debounce(struct ata_link *link,
758                         const unsigned long *params, unsigned long deadline);
759 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
760                             unsigned long deadline);
761 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
762 extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
763                              unsigned long deadline);
764 extern int sata_link_hardreset(struct ata_link *link,
765                         const unsigned long *timing, unsigned long deadline);
766 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
767                               unsigned long deadline);
768 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
769 extern void ata_port_disable(struct ata_port *);
770 extern void ata_std_ports(struct ata_ioports *ioaddr);
771 #ifdef CONFIG_PCI
772 extern int ata_pci_init_one (struct pci_dev *pdev,
773                              const struct ata_port_info * const * ppi);
774 extern void ata_pci_remove_one (struct pci_dev *pdev);
775 #ifdef CONFIG_PM
776 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
777 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
778 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
779 extern int ata_pci_device_resume(struct pci_dev *pdev);
780 #endif
781 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
782 #endif /* CONFIG_PCI */
783 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
784 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
785                         const struct ata_port_info * const * ppi, int n_ports);
786 extern int ata_host_start(struct ata_host *host);
787 extern int ata_host_register(struct ata_host *host,
788                              struct scsi_host_template *sht);
789 extern int ata_host_activate(struct ata_host *host, int irq,
790                              irq_handler_t irq_handler, unsigned long irq_flags,
791                              struct scsi_host_template *sht);
792 extern void ata_host_detach(struct ata_host *host);
793 extern void ata_host_init(struct ata_host *, struct device *,
794                           unsigned long, const struct ata_port_operations *);
795 extern int ata_scsi_detect(struct scsi_host_template *sht);
796 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
797 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
798 extern void ata_sas_port_destroy(struct ata_port *);
799 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
800                                            struct ata_port_info *, struct Scsi_Host *);
801 extern int ata_sas_port_init(struct ata_port *);
802 extern int ata_sas_port_start(struct ata_port *ap);
803 extern void ata_sas_port_stop(struct ata_port *ap);
804 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
805 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
806                             struct ata_port *ap);
807 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
808 extern int sata_scr_valid(struct ata_link *link);
809 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
810 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
811 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
812 extern int ata_link_online(struct ata_link *link);
813 extern int ata_link_offline(struct ata_link *link);
814 #ifdef CONFIG_PM
815 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
816 extern void ata_host_resume(struct ata_host *host);
817 #endif
818 extern int ata_ratelimit(void);
819 extern int ata_busy_sleep(struct ata_port *ap,
820                           unsigned long timeout_pat, unsigned long timeout);
821 extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
822 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
823                                 void *data, unsigned long delay);
824 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
825                              unsigned long interval_msec,
826                              unsigned long timeout_msec);
827 extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
828                                          u8 *r_err);
829
830 /*
831  * Default driver ops implementations
832  */
833 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
834 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
835 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
836                           u8 pmp, int is_cmd, u8 *fis);
837 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
838 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
839 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
840 extern u8 ata_check_status(struct ata_port *ap);
841 extern u8 ata_altstatus(struct ata_port *ap);
842 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
843 extern int ata_port_start (struct ata_port *ap);
844 extern int ata_sff_port_start (struct ata_port *ap);
845 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
846 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
847                           unsigned int buflen, int write_data);
848 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
849                                 unsigned int buflen, int write_data);
850 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
851 extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
852 extern void ata_qc_prep(struct ata_queued_cmd *qc);
853 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
854 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
855 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
856                 unsigned int buflen);
857 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
858                  unsigned int n_elem);
859 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
860 extern void ata_dev_disable(struct ata_device *adev);
861 extern void ata_id_string(const u16 *id, unsigned char *s,
862                           unsigned int ofs, unsigned int len);
863 extern void ata_id_c_string(const u16 *id, unsigned char *s,
864                             unsigned int ofs, unsigned int len);
865 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
866 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
867 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
868 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
869 extern u8   ata_bmdma_status(struct ata_port *ap);
870 extern void ata_bmdma_irq_clear(struct ata_port *ap);
871 extern void ata_bmdma_freeze(struct ata_port *ap);
872 extern void ata_bmdma_thaw(struct ata_port *ap);
873 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
874                                ata_reset_fn_t softreset,
875                                ata_reset_fn_t hardreset,
876                                ata_postreset_fn_t postreset);
877 extern void ata_bmdma_error_handler(struct ata_port *ap);
878 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
879 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
880                         u8 status, int in_wq);
881 extern void ata_qc_complete(struct ata_queued_cmd *qc);
882 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
883                                     void (*finish_qc)(struct ata_queued_cmd *));
884 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
885                               void (*done)(struct scsi_cmnd *));
886 extern int ata_std_bios_param(struct scsi_device *sdev,
887                               struct block_device *bdev,
888                               sector_t capacity, int geom[]);
889 extern int ata_scsi_slave_config(struct scsi_device *sdev);
890 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
891 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
892                                        int queue_depth);
893 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
894 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
895 extern u8 ata_irq_on(struct ata_port *ap);
896
897 extern int ata_cable_40wire(struct ata_port *ap);
898 extern int ata_cable_80wire(struct ata_port *ap);
899 extern int ata_cable_sata(struct ata_port *ap);
900 extern int ata_cable_unknown(struct ata_port *ap);
901
902 /*
903  * Timing helpers
904  */
905
906 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
907 extern int ata_timing_compute(struct ata_device *, unsigned short,
908                               struct ata_timing *, int, int);
909 extern void ata_timing_merge(const struct ata_timing *,
910                              const struct ata_timing *, struct ata_timing *,
911                              unsigned int);
912
913 enum {
914         ATA_TIMING_SETUP        = (1 << 0),
915         ATA_TIMING_ACT8B        = (1 << 1),
916         ATA_TIMING_REC8B        = (1 << 2),
917         ATA_TIMING_CYC8B        = (1 << 3),
918         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
919                                   ATA_TIMING_CYC8B,
920         ATA_TIMING_ACTIVE       = (1 << 4),
921         ATA_TIMING_RECOVER      = (1 << 5),
922         ATA_TIMING_CYCLE        = (1 << 6),
923         ATA_TIMING_UDMA         = (1 << 7),
924         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
925                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
926                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
927                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
928 };
929
930 /* libata-acpi.c */
931 #ifdef CONFIG_ATA_ACPI
932 extern int ata_acpi_cbl_80wire(struct ata_port *ap);
933 int ata_acpi_stm(const struct ata_port *ap, struct ata_acpi_gtm *stm);
934 int ata_acpi_gtm(const struct ata_port *ap, struct ata_acpi_gtm *stm);
935 #else
936 static inline int ata_acpi_cbl_80wire(struct ata_port *ap) { return 0; }
937 #endif
938
939 #ifdef CONFIG_PCI
940 struct pci_bits {
941         unsigned int            reg;    /* PCI config register to read */
942         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
943         unsigned long           mask;
944         unsigned long           val;
945 };
946
947 extern int ata_pci_init_sff_host(struct ata_host *host);
948 extern int ata_pci_init_bmdma(struct ata_host *host);
949 extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
950                                     const struct ata_port_info * const * ppi,
951                                     struct ata_host **r_host);
952 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
953 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
954 #endif /* CONFIG_PCI */
955
956 /*
957  * PMP
958  */
959 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
960 extern void sata_pmp_read_init_tf(struct ata_taskfile *tf,
961                                   struct ata_device *dev, int pmp, int reg);
962 extern u32 sata_pmp_read_val(const struct ata_taskfile *tf);
963 extern void sata_pmp_write_init_tf(struct ata_taskfile *tf,
964                                    struct ata_device *dev,
965                                    int pmp, int reg, u32 val);
966 extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline);
967 extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class,
968                                   unsigned long deadline);
969 extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class);
970 extern void sata_pmp_do_eh(struct ata_port *ap,
971                 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
972                 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset,
973                 ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset,
974                 ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset);
975
976 /*
977  * EH
978  */
979 extern void ata_eng_timeout(struct ata_port *ap);
980
981 extern void ata_port_schedule_eh(struct ata_port *ap);
982 extern int ata_link_abort(struct ata_link *link);
983 extern int ata_port_abort(struct ata_port *ap);
984 extern int ata_port_freeze(struct ata_port *ap);
985 extern int sata_async_notification(struct ata_port *ap);
986
987 extern void ata_eh_freeze_port(struct ata_port *ap);
988 extern void ata_eh_thaw_port(struct ata_port *ap);
989
990 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
991 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
992
993 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
994                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
995                       ata_postreset_fn_t postreset);
996
997 /*
998  * printk helpers
999  */
1000 #define ata_port_printk(ap, lv, fmt, args...) \
1001         printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
1002
1003 #define ata_link_printk(link, lv, fmt, args...) do { \
1004         if ((link)->ap->nr_pmp_links) \
1005                 printk(lv"ata%u.%02u: "fmt, (link)->ap->print_id, \
1006                        (link)->pmp , ##args); \
1007         else \
1008                 printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args); \
1009         } while(0)
1010
1011 #define ata_dev_printk(dev, lv, fmt, args...) \
1012         printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, \
1013                (dev)->link->pmp + (dev)->devno , ##args)
1014
1015 /*
1016  * ata_eh_info helpers
1017  */
1018 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1019         __attribute__ ((format (printf, 2, 3)));
1020 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1021         __attribute__ ((format (printf, 2, 3)));
1022 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1023
1024 static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
1025 {
1026         ehi->flags |= ATA_EHI_RESUME_LINK;
1027         ehi->action |= ATA_EH_SOFTRESET;
1028         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1029 }
1030
1031 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1032 {
1033         ata_ehi_schedule_probe(ehi);
1034         ehi->flags |= ATA_EHI_HOTPLUGGED;
1035         ehi->action |= ATA_EH_ENABLE_LINK;
1036         ehi->err_mask |= AC_ERR_ATA_BUS;
1037 }
1038
1039 /*
1040  * port description helpers
1041  */
1042 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1043         __attribute__ ((format (printf, 2, 3)));
1044 #ifdef CONFIG_PCI
1045 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1046                                const char *name);
1047 #endif
1048
1049 /*
1050  * qc helpers
1051  */
1052 static inline int
1053 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
1054 {
1055         if (sg == &qc->pad_sgent)
1056                 return 1;
1057         if (qc->pad_len)
1058                 return 0;
1059         if (((sg - qc->__sg) + 1) == qc->n_elem)
1060                 return 1;
1061         return 0;
1062 }
1063
1064 static inline struct scatterlist *
1065 ata_qc_first_sg(struct ata_queued_cmd *qc)
1066 {
1067         if (qc->n_elem)
1068                 return qc->__sg;
1069         if (qc->pad_len)
1070                 return &qc->pad_sgent;
1071         return NULL;
1072 }
1073
1074 static inline struct scatterlist *
1075 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
1076 {
1077         if (sg == &qc->pad_sgent)
1078                 return NULL;
1079         if (++sg - qc->__sg < qc->n_elem)
1080                 return sg;
1081         if (qc->pad_len)
1082                 return &qc->pad_sgent;
1083         return NULL;
1084 }
1085
1086 #define ata_for_each_sg(sg, qc) \
1087         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
1088
1089 static inline unsigned int ata_tag_valid(unsigned int tag)
1090 {
1091         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1092 }
1093
1094 static inline unsigned int ata_tag_internal(unsigned int tag)
1095 {
1096         return tag == ATA_MAX_QUEUE - 1;
1097 }
1098
1099 /*
1100  * device helpers
1101  */
1102 static inline unsigned int ata_class_enabled(unsigned int class)
1103 {
1104         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1105                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1106 }
1107
1108 static inline unsigned int ata_class_disabled(unsigned int class)
1109 {
1110         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1111                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1112 }
1113
1114 static inline unsigned int ata_class_absent(unsigned int class)
1115 {
1116         return !ata_class_enabled(class) && !ata_class_disabled(class);
1117 }
1118
1119 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1120 {
1121         return ata_class_enabled(dev->class);
1122 }
1123
1124 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1125 {
1126         return ata_class_disabled(dev->class);
1127 }
1128
1129 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1130 {
1131         return ata_class_absent(dev->class);
1132 }
1133
1134 /*
1135  * link helpers
1136  */
1137 static inline int ata_is_host_link(const struct ata_link *link)
1138 {
1139         return link == &link->ap->link;
1140 }
1141
1142 static inline int ata_link_max_devices(const struct ata_link *link)
1143 {
1144         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1145                 return 2;
1146         return 1;
1147 }
1148
1149 static inline int ata_link_active(struct ata_link *link)
1150 {
1151         return ata_tag_valid(link->active_tag) || link->sactive;
1152 }
1153
1154 static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1155 {
1156         if (ap->nr_pmp_links)
1157                 return ap->pmp_link;
1158         return &ap->link;
1159 }
1160
1161 static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1162 {
1163         struct ata_port *ap = link->ap;
1164
1165         if (link == &ap->link) {
1166                 if (!ap->nr_pmp_links)
1167                         return NULL;
1168                 return ap->pmp_link;
1169         }
1170
1171         if (++link - ap->pmp_link < ap->nr_pmp_links)
1172                 return link;
1173         return NULL;
1174 }
1175
1176 #define __ata_port_for_each_link(lk, ap) \
1177         for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1178
1179 #define ata_port_for_each_link(link, ap) \
1180         for ((link) = ata_port_first_link(ap); (link); \
1181              (link) = ata_port_next_link(link))
1182
1183 #define ata_link_for_each_dev(dev, link) \
1184         for ((dev) = (link)->device; \
1185              (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1186              (dev)++)
1187
1188 #define ata_link_for_each_dev_reverse(dev, link) \
1189         for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1190              (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1191
1192 static inline u8 ata_chk_status(struct ata_port *ap)
1193 {
1194         return ap->ops->check_status(ap);
1195 }
1196
1197 /**
1198  *      ata_ncq_enabled - Test whether NCQ is enabled
1199  *      @dev: ATA device to test for
1200  *
1201  *      LOCKING:
1202  *      spin_lock_irqsave(host lock)
1203  *
1204  *      RETURNS:
1205  *      1 if NCQ is enabled for @dev, 0 otherwise.
1206  */
1207 static inline int ata_ncq_enabled(struct ata_device *dev)
1208 {
1209         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1210                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1211 }
1212
1213 /**
1214  *      ata_pause - Flush writes and pause 400 nanoseconds.
1215  *      @ap: Port to wait for.
1216  *
1217  *      LOCKING:
1218  *      Inherited from caller.
1219  */
1220
1221 static inline void ata_pause(struct ata_port *ap)
1222 {
1223         ata_altstatus(ap);
1224         ndelay(400);
1225 }
1226
1227
1228 /**
1229  *      ata_busy_wait - Wait for a port status register
1230  *      @ap: Port to wait for.
1231  *      @bits: bits that must be clear
1232  *      @max: number of 10uS waits to perform
1233  *
1234  *      Waits up to max*10 microseconds for the selected bits in the port's
1235  *      status register to be cleared.
1236  *      Returns final value of status register.
1237  *
1238  *      LOCKING:
1239  *      Inherited from caller.
1240  */
1241
1242 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1243                                unsigned int max)
1244 {
1245         u8 status;
1246
1247         do {
1248                 udelay(10);
1249                 status = ata_chk_status(ap);
1250                 max--;
1251         } while (status != 0xff && (status & bits) && (max > 0));
1252
1253         return status;
1254 }
1255
1256
1257 /**
1258  *      ata_wait_idle - Wait for a port to be idle.
1259  *      @ap: Port to wait for.
1260  *
1261  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1262  *      Returns final value of status register.
1263  *
1264  *      LOCKING:
1265  *      Inherited from caller.
1266  */
1267
1268 static inline u8 ata_wait_idle(struct ata_port *ap)
1269 {
1270         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1271
1272 #ifdef ATA_DEBUG
1273         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1274                 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1275                                 status);
1276 #endif
1277
1278         return status;
1279 }
1280
1281 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1282 {
1283         qc->tf.ctl |= ATA_NIEN;
1284 }
1285
1286 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1287                                                        unsigned int tag)
1288 {
1289         if (likely(ata_tag_valid(tag)))
1290                 return &ap->qcmd[tag];
1291         return NULL;
1292 }
1293
1294 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1295                                                      unsigned int tag)
1296 {
1297         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1298
1299         if (unlikely(!qc) || !ap->ops->error_handler)
1300                 return qc;
1301
1302         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1303                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1304                 return qc;
1305
1306         return NULL;
1307 }
1308
1309 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1310 {
1311         memset(tf, 0, sizeof(*tf));
1312
1313         tf->ctl = dev->link->ap->ctl;
1314         if (dev->devno == 0)
1315                 tf->device = ATA_DEVICE_OBS;
1316         else
1317                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1318 }
1319
1320 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1321 {
1322         qc->dma_dir = DMA_NONE;
1323         qc->__sg = NULL;
1324         qc->flags = 0;
1325         qc->cursg = qc->cursg_ofs = 0;
1326         qc->nbytes = qc->curbytes = 0;
1327         qc->n_elem = 0;
1328         qc->err_mask = 0;
1329         qc->pad_len = 0;
1330         qc->sect_size = ATA_SECT_SIZE;
1331
1332         ata_tf_init(qc->dev, &qc->tf);
1333
1334         /* init result_tf such that it indicates normal completion */
1335         qc->result_tf.command = ATA_DRDY;
1336         qc->result_tf.feature = 0;
1337 }
1338
1339 static inline int ata_try_flush_cache(const struct ata_device *dev)
1340 {
1341         return ata_id_wcache_enabled(dev->id) ||
1342                ata_id_has_flush(dev->id) ||
1343                ata_id_has_flush_ext(dev->id);
1344 }
1345
1346 static inline unsigned int ac_err_mask(u8 status)
1347 {
1348         if (status & (ATA_BUSY | ATA_DRQ))
1349                 return AC_ERR_HSM;
1350         if (status & (ATA_ERR | ATA_DF))
1351                 return AC_ERR_DEV;
1352         return 0;
1353 }
1354
1355 static inline unsigned int __ac_err_mask(u8 status)
1356 {
1357         unsigned int mask = ac_err_mask(status);
1358         if (mask == 0)
1359                 return AC_ERR_OTHER;
1360         return mask;
1361 }
1362
1363 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1364 {
1365         ap->pad_dma = 0;
1366         ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1367                                       &ap->pad_dma, GFP_KERNEL);
1368         return (ap->pad == NULL) ? -ENOMEM : 0;
1369 }
1370
1371 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1372 {
1373         dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1374 }
1375
1376 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1377 {
1378         return *(struct ata_port **)&host->hostdata[0];
1379 }
1380
1381 #endif /* __LINUX_LIBATA_H__ */