libata: improve EH retry delay handling
[safe/jmp/linux-2.6] / 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/jiffies.h>
31 #include <linux/interrupt.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/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 #include <linux/cdrom.h>
40
41 /*
42  * Define if arch has non-standard setup.  This is a _PCI_ standard
43  * not a legacy or ISA standard.
44  */
45 #ifdef CONFIG_ATA_NONSTANDARD
46 #include <asm/libata-portmap.h>
47 #else
48 #include <asm-generic/libata-portmap.h>
49 #endif
50
51 /*
52  * compile-time options: to be removed as soon as all the drivers are
53  * converted to the new debugging mechanism
54  */
55 #undef ATA_DEBUG                /* debugging output */
56 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
57 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
58 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
59
60
61 /* note: prints function name for you */
62 #ifdef ATA_DEBUG
63 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64 #ifdef ATA_VERBOSE_DEBUG
65 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
66 #else
67 #define VPRINTK(fmt, args...)
68 #endif  /* ATA_VERBOSE_DEBUG */
69 #else
70 #define DPRINTK(fmt, args...)
71 #define VPRINTK(fmt, args...)
72 #endif  /* ATA_DEBUG */
73
74 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
75
76 /* NEW: debug levels */
77 #define HAVE_LIBATA_MSG 1
78
79 enum {
80         ATA_MSG_DRV     = 0x0001,
81         ATA_MSG_INFO    = 0x0002,
82         ATA_MSG_PROBE   = 0x0004,
83         ATA_MSG_WARN    = 0x0008,
84         ATA_MSG_MALLOC  = 0x0010,
85         ATA_MSG_CTL     = 0x0020,
86         ATA_MSG_INTR    = 0x0040,
87         ATA_MSG_ERR     = 0x0080,
88 };
89
90 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
91 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
92 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
93 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
94 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
96 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
97 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
98
99 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100 {
101         if (dval < 0 || dval >= (sizeof(u32) * 8))
102                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
103         if (!dval)
104                 return 0;
105         return (1 << dval) - 1;
106 }
107
108 /* defines only for the constants which don't work well as enums */
109 #define ATA_TAG_POISON          0xfafbfcfdU
110
111 enum {
112         /* various global constants */
113         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
114         LIBATA_DUMB_MAX_PRD     = ATA_MAX_PRD / 4,      /* Worst case */
115         ATA_DEF_QUEUE           = 1,
116         /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
117         ATA_MAX_QUEUE           = 32,
118         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE - 1,
119         ATA_SHORT_PAUSE         = 16,
120
121         ATAPI_MAX_DRAIN         = 16 << 10,
122
123         ATA_ALL_DEVICES         = (1 << ATA_MAX_DEVICES) - 1,
124
125         ATA_SHT_EMULATED        = 1,
126         ATA_SHT_CMD_PER_LUN     = 1,
127         ATA_SHT_THIS_ID         = -1,
128         ATA_SHT_USE_CLUSTERING  = 1,
129
130         /* struct ata_device stuff */
131         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
132         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
133         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
134         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
135         ATA_DFLAG_FLUSH_EXT     = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
136         ATA_DFLAG_ACPI_PENDING  = (1 << 5), /* ACPI resume action pending */
137         ATA_DFLAG_ACPI_FAILED   = (1 << 6), /* ACPI on devcfg has failed */
138         ATA_DFLAG_AN            = (1 << 7), /* AN configured */
139         ATA_DFLAG_HIPM          = (1 << 8), /* device supports HIPM */
140         ATA_DFLAG_DIPM          = (1 << 9), /* device supports DIPM */
141         ATA_DFLAG_DMADIR        = (1 << 10), /* device requires DMADIR */
142         ATA_DFLAG_CFG_MASK      = (1 << 12) - 1,
143
144         ATA_DFLAG_PIO           = (1 << 12), /* device limited to PIO mode */
145         ATA_DFLAG_NCQ_OFF       = (1 << 13), /* device limited to non-NCQ mode */
146         ATA_DFLAG_SPUNDOWN      = (1 << 14), /* XXX: for spindown_compat */
147         ATA_DFLAG_SLEEPING      = (1 << 15), /* device is sleeping */
148         ATA_DFLAG_DUBIOUS_XFER  = (1 << 16), /* data transfer not verified */
149         ATA_DFLAG_INIT_MASK     = (1 << 24) - 1,
150
151         ATA_DFLAG_DETACH        = (1 << 24),
152         ATA_DFLAG_DETACHED      = (1 << 25),
153
154         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
155         ATA_DEV_ATA             = 1,    /* ATA device */
156         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
157         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
158         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
159         ATA_DEV_PMP             = 5,    /* SATA port multiplier */
160         ATA_DEV_PMP_UNSUP       = 6,    /* SATA port multiplier (unsupported) */
161         ATA_DEV_SEMB            = 7,    /* SEMB */
162         ATA_DEV_SEMB_UNSUP      = 8,    /* SEMB (unsupported) */
163         ATA_DEV_NONE            = 9,    /* no device */
164
165         /* struct ata_link flags */
166         ATA_LFLAG_NO_SRST       = (1 << 2), /* avoid softreset */
167         ATA_LFLAG_ASSUME_ATA    = (1 << 3), /* assume ATA class */
168         ATA_LFLAG_ASSUME_SEMB   = (1 << 4), /* assume SEMB class */
169         ATA_LFLAG_ASSUME_CLASS  = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
170         ATA_LFLAG_NO_RETRY      = (1 << 5), /* don't retry this link */
171         ATA_LFLAG_DISABLED      = (1 << 6), /* link is disabled */
172
173         /* struct ata_port flags */
174         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
175                                             /* (doesn't imply presence) */
176         ATA_FLAG_SATA           = (1 << 1),
177         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
178         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
179         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
180         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
181         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
182         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
183         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
184         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
185                                              * doesn't handle PIO interrupts */
186         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
187         ATA_FLAG_DEBUGMSG       = (1 << 13),
188         ATA_FLAG_IGN_SIMPLEX    = (1 << 15), /* ignore SIMPLEX */
189         ATA_FLAG_NO_IORDY       = (1 << 16), /* controller lacks iordy */
190         ATA_FLAG_ACPI_SATA      = (1 << 17), /* need native SATA ACPI layout */
191         ATA_FLAG_AN             = (1 << 18), /* controller supports AN */
192         ATA_FLAG_PMP            = (1 << 19), /* controller supports PMP */
193         ATA_FLAG_IPM            = (1 << 20), /* driver can handle IPM */
194
195         /* The following flag belongs to ap->pflags but is kept in
196          * ap->flags because it's referenced in many LLDs and will be
197          * removed in not-too-distant future.
198          */
199         ATA_FLAG_DISABLED       = (1 << 23), /* port is disabled, ignore it */
200
201         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
202
203         /* struct ata_port pflags */
204         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
205         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
206         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
207         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
208         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
209         ATA_PFLAG_UNLOADING     = (1 << 5), /* module is unloading */
210         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
211         ATA_PFLAG_INITIALIZING  = (1 << 7), /* being initialized, don't touch */
212         ATA_PFLAG_RESETTING     = (1 << 8), /* reset in progress */
213
214         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
215         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
216         ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
217
218         /* struct ata_queued_cmd flags */
219         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
220         ATA_QCFLAG_DMAMAP       = (1 << 1), /* SG table is DMA mapped */
221         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
222         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
223         ATA_QCFLAG_CLEAR_EXCL   = (1 << 5), /* clear excl_link on completion */
224         ATA_QCFLAG_QUIET        = (1 << 6), /* don't report device error */
225         ATA_QCFLAG_RETRY        = (1 << 7), /* retry after failure */
226
227         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
228         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
229         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
230
231         /* host set flags */
232         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
233         ATA_HOST_STARTED        = (1 << 1),     /* Host started */
234
235         /* bits 24:31 of host->flags are reserved for LLD specific flags */
236
237         /* various lengths of time */
238         ATA_TMOUT_BOOT          = 30000,        /* heuristic */
239         ATA_TMOUT_BOOT_QUICK    =  7000,        /* heuristic */
240         ATA_TMOUT_INTERNAL      = 30000,
241         ATA_TMOUT_INTERNAL_QUICK = 5000,
242
243         /* FIXME: GoVault needs 2s but we can't afford that without
244          * parallel probing.  800ms is enough for iVDR disk
245          * HHD424020F7SV00.  Increase to 2secs when parallel probing
246          * is in place.
247          */
248         ATA_TMOUT_FF_WAIT       =  800,
249
250         /* Spec mandates to wait for ">= 2ms" before checking status
251          * after reset.  We wait 150ms, because that was the magic
252          * delay used for ATAPI devices in Hale Landis's ATADRVR, for
253          * the period of time between when the ATA command register is
254          * written, and then status is checked.  Because waiting for
255          * "a while" before checking status is fine, post SRST, we
256          * perform this magic delay here as well.
257          *
258          * Old drivers/ide uses the 2mS rule and then waits for ready.
259          */
260         ATA_WAIT_AFTER_RESET    =  150,
261
262         /* If PMP is supported, we have to do follow-up SRST.  As some
263          * PMPs don't send D2H Reg FIS after hardreset, LLDs are
264          * advised to wait only for the following duration before
265          * doing SRST.
266          */
267         ATA_TMOUT_PMP_SRST_WAIT = 1000,
268
269         /* ATA bus states */
270         BUS_UNKNOWN             = 0,
271         BUS_DMA                 = 1,
272         BUS_IDLE                = 2,
273         BUS_NOINTR              = 3,
274         BUS_NODATA              = 4,
275         BUS_TIMER               = 5,
276         BUS_PIO                 = 6,
277         BUS_EDD                 = 7,
278         BUS_IDENTIFY            = 8,
279         BUS_PACKET              = 9,
280
281         /* SATA port states */
282         PORT_UNKNOWN            = 0,
283         PORT_ENABLED            = 1,
284         PORT_DISABLED           = 2,
285
286         /* encoding various smaller bitmaps into a single
287          * unsigned long bitmap
288          */
289         ATA_NR_PIO_MODES        = 7,
290         ATA_NR_MWDMA_MODES      = 5,
291         ATA_NR_UDMA_MODES       = 8,
292
293         ATA_SHIFT_PIO           = 0,
294         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
295         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
296
297         /* size of buffer to pad xfers ending on unaligned boundaries */
298         ATA_DMA_PAD_SZ          = 4,
299
300         /* ering size */
301         ATA_ERING_SIZE          = 32,
302
303         /* return values for ->qc_defer */
304         ATA_DEFER_LINK          = 1,
305         ATA_DEFER_PORT          = 2,
306
307         /* desc_len for ata_eh_info and context */
308         ATA_EH_DESC_LEN         = 80,
309
310         /* reset / recovery action types */
311         ATA_EH_REVALIDATE       = (1 << 0),
312         ATA_EH_SOFTRESET        = (1 << 1), /* meaningful only in ->prereset */
313         ATA_EH_HARDRESET        = (1 << 2), /* meaningful only in ->prereset */
314         ATA_EH_RESET            = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
315         ATA_EH_ENABLE_LINK      = (1 << 3),
316         ATA_EH_LPM              = (1 << 4),  /* link power management action */
317
318         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE,
319
320         /* ata_eh_info->flags */
321         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
322         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
323         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
324
325         ATA_EHI_DID_SOFTRESET   = (1 << 16), /* already soft-reset this port */
326         ATA_EHI_DID_HARDRESET   = (1 << 17), /* already soft-reset this port */
327         ATA_EHI_PRINTINFO       = (1 << 18), /* print configuration info */
328         ATA_EHI_SETMODE         = (1 << 19), /* configure transfer mode */
329         ATA_EHI_POST_SETMODE    = (1 << 20), /* revaildating after setmode */
330
331         ATA_EHI_DID_RESET       = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
332
333         /* max tries if error condition is still set after ->error_handler */
334         ATA_EH_MAX_TRIES        = 5,
335
336         /* how hard are we gonna try to probe/recover devices */
337         ATA_PROBE_MAX_TRIES     = 3,
338         ATA_EH_DEV_TRIES        = 3,
339         ATA_EH_PMP_TRIES        = 5,
340         ATA_EH_PMP_LINK_TRIES   = 3,
341
342         SATA_PMP_RW_TIMEOUT     = 3000,         /* PMP read/write timeout */
343
344         /* Horkage types. May be set by libata or controller on drives
345            (some horkage may be drive/controller pair dependant */
346
347         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
348         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
349         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
350         ATA_HORKAGE_MAX_SEC_128 = (1 << 3),     /* Limit max sects to 128 */
351         ATA_HORKAGE_BROKEN_HPA  = (1 << 4),     /* Broken HPA */
352         ATA_HORKAGE_DISABLE     = (1 << 5),     /* Disable it */
353         ATA_HORKAGE_HPA_SIZE    = (1 << 6),     /* native size off by one */
354         ATA_HORKAGE_IPM         = (1 << 7),     /* Link PM problems */
355         ATA_HORKAGE_IVB         = (1 << 8),     /* cbl det validity bit bugs */
356         ATA_HORKAGE_STUCK_ERR   = (1 << 9),     /* stuck ERR on next PACKET */
357
358          /* DMA mask for user DMA control: User visible values; DO NOT
359             renumber */
360         ATA_DMA_MASK_ATA        = (1 << 0),     /* DMA on ATA Disk */
361         ATA_DMA_MASK_ATAPI      = (1 << 1),     /* DMA on ATAPI */
362         ATA_DMA_MASK_CFA        = (1 << 2),     /* DMA on CF Card */
363
364         /* ATAPI command types */
365         ATAPI_READ              = 0,            /* READs */
366         ATAPI_WRITE             = 1,            /* WRITEs */
367         ATAPI_READ_CD           = 2,            /* READ CD [MSF] */
368         ATAPI_PASS_THRU         = 3,            /* SAT pass-thru */
369         ATAPI_MISC              = 4,            /* the rest */
370
371         /* Timing constants */
372         ATA_TIMING_SETUP        = (1 << 0),
373         ATA_TIMING_ACT8B        = (1 << 1),
374         ATA_TIMING_REC8B        = (1 << 2),
375         ATA_TIMING_CYC8B        = (1 << 3),
376         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
377                                   ATA_TIMING_CYC8B,
378         ATA_TIMING_ACTIVE       = (1 << 4),
379         ATA_TIMING_RECOVER      = (1 << 5),
380         ATA_TIMING_CYCLE        = (1 << 6),
381         ATA_TIMING_UDMA         = (1 << 7),
382         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
383                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
384                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
385                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
386 };
387
388 enum ata_xfer_mask {
389         ATA_MASK_PIO            = ((1LU << ATA_NR_PIO_MODES) - 1)
390                                         << ATA_SHIFT_PIO,
391         ATA_MASK_MWDMA          = ((1LU << ATA_NR_MWDMA_MODES) - 1)
392                                         << ATA_SHIFT_MWDMA,
393         ATA_MASK_UDMA           = ((1LU << ATA_NR_UDMA_MODES) - 1)
394                                         << ATA_SHIFT_UDMA,
395 };
396
397 enum hsm_task_states {
398         HSM_ST_IDLE,            /* no command on going */
399         HSM_ST_FIRST,           /* (waiting the device to)
400                                    write CDB or first data block */
401         HSM_ST,                 /* (waiting the device to) transfer data */
402         HSM_ST_LAST,            /* (waiting the device to) complete command */
403         HSM_ST_ERR,             /* error */
404 };
405
406 enum ata_completion_errors {
407         AC_ERR_DEV              = (1 << 0), /* device reported error */
408         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
409         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
410         AC_ERR_MEDIA            = (1 << 3), /* media error */
411         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
412         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
413         AC_ERR_SYSTEM           = (1 << 6), /* system error */
414         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
415         AC_ERR_OTHER            = (1 << 8), /* unknown */
416         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
417         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
418 };
419
420 /* forward declarations */
421 struct scsi_device;
422 struct ata_port_operations;
423 struct ata_port;
424 struct ata_link;
425 struct ata_queued_cmd;
426
427 /* typedefs */
428 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
429 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
430 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
431                               unsigned long deadline);
432 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
433
434 /*
435  * host pm policy: If you alter this, you also need to alter libata-scsi.c
436  * (for the ascii descriptions)
437  */
438 enum link_pm {
439         NOT_AVAILABLE,
440         MIN_POWER,
441         MAX_PERFORMANCE,
442         MEDIUM_POWER,
443 };
444 extern struct device_attribute dev_attr_link_power_management_policy;
445
446 #ifdef CONFIG_ATA_SFF
447 struct ata_ioports {
448         void __iomem            *cmd_addr;
449         void __iomem            *data_addr;
450         void __iomem            *error_addr;
451         void __iomem            *feature_addr;
452         void __iomem            *nsect_addr;
453         void __iomem            *lbal_addr;
454         void __iomem            *lbam_addr;
455         void __iomem            *lbah_addr;
456         void __iomem            *device_addr;
457         void __iomem            *status_addr;
458         void __iomem            *command_addr;
459         void __iomem            *altstatus_addr;
460         void __iomem            *ctl_addr;
461         void __iomem            *bmdma_addr;
462         void __iomem            *scr_addr;
463 };
464 #endif /* CONFIG_ATA_SFF */
465
466 struct ata_host {
467         spinlock_t              lock;
468         struct device           *dev;
469         void __iomem * const    *iomap;
470         unsigned int            n_ports;
471         void                    *private_data;
472         struct ata_port_operations *ops;
473         unsigned long           flags;
474 #ifdef CONFIG_ATA_ACPI
475         acpi_handle             acpi_handle;
476 #endif
477         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
478         struct ata_port         *ports[0];
479 };
480
481 struct ata_queued_cmd {
482         struct ata_port         *ap;
483         struct ata_device       *dev;
484
485         struct scsi_cmnd        *scsicmd;
486         void                    (*scsidone)(struct scsi_cmnd *);
487
488         struct ata_taskfile     tf;
489         u8                      cdb[ATAPI_CDB_LEN];
490
491         unsigned long           flags;          /* ATA_QCFLAG_xxx */
492         unsigned int            tag;
493         unsigned int            n_elem;
494
495         int                     dma_dir;
496
497         unsigned int            sect_size;
498
499         unsigned int            nbytes;
500         unsigned int            extrabytes;
501         unsigned int            curbytes;
502
503         struct scatterlist      *cursg;
504         unsigned int            cursg_ofs;
505
506         struct scatterlist      sgent;
507
508         struct scatterlist      *sg;
509
510         unsigned int            err_mask;
511         struct ata_taskfile     result_tf;
512         ata_qc_cb_t             complete_fn;
513
514         void                    *private_data;
515         void                    *lldd_task;
516 };
517
518 struct ata_port_stats {
519         unsigned long           unhandled_irq;
520         unsigned long           idle_irq;
521         unsigned long           rw_reqbuf;
522 };
523
524 struct ata_ering_entry {
525         unsigned int            eflags;
526         unsigned int            err_mask;
527         u64                     timestamp;
528 };
529
530 struct ata_ering {
531         int                     cursor;
532         struct ata_ering_entry  ring[ATA_ERING_SIZE];
533 };
534
535 struct ata_device {
536         struct ata_link         *link;
537         unsigned int            devno;          /* 0 or 1 */
538         unsigned long           flags;          /* ATA_DFLAG_xxx */
539         unsigned int            horkage;        /* List of broken features */
540         struct scsi_device      *sdev;          /* attached SCSI device */
541 #ifdef CONFIG_ATA_ACPI
542         acpi_handle             acpi_handle;
543         union acpi_object       *gtf_cache;
544 #endif
545         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
546         u64                     n_sectors;      /* size of device, if ATA */
547         unsigned int            class;          /* ATA_DEV_xxx */
548
549         u8                      pio_mode;
550         u8                      dma_mode;
551         u8                      xfer_mode;
552         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
553
554         unsigned int            multi_count;    /* sectors count for
555                                                    READ/WRITE MULTIPLE */
556         unsigned int            max_sectors;    /* per-device max sectors */
557         unsigned int            cdb_len;
558
559         /* per-dev xfer mask */
560         unsigned long           pio_mask;
561         unsigned long           mwdma_mask;
562         unsigned long           udma_mask;
563
564         /* for CHS addressing */
565         u16                     cylinders;      /* Number of cylinders */
566         u16                     heads;          /* Number of heads */
567         u16                     sectors;        /* Number of sectors per track */
568
569         /* error history */
570         int                     spdn_cnt;
571         struct ata_ering        ering;
572
573         union {
574                 u16             id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
575                 u32             gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
576         };
577 };
578
579 /* Offset into struct ata_device.  Fields above it are maintained
580  * acress device init.  Fields below are zeroed.
581  */
582 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
583
584 struct ata_eh_info {
585         struct ata_device       *dev;           /* offending device */
586         u32                     serror;         /* SError from LLDD */
587         unsigned int            err_mask;       /* port-wide err_mask */
588         unsigned int            action;         /* ATA_EH_* action mask */
589         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
590         unsigned int            flags;          /* ATA_EHI_* flags */
591
592         unsigned int            probe_mask;
593
594         char                    desc[ATA_EH_DESC_LEN];
595         int                     desc_len;
596 };
597
598 struct ata_eh_context {
599         struct ata_eh_info      i;
600         int                     tries[ATA_MAX_DEVICES];
601         unsigned int            classes[ATA_MAX_DEVICES];
602         unsigned int            did_probe_mask;
603         unsigned int            saved_ncq_enabled;
604         u8                      saved_xfer_mode[ATA_MAX_DEVICES];
605         /* timestamp for the last reset attempt or success */
606         unsigned long           last_reset;
607 };
608
609 struct ata_acpi_drive
610 {
611         u32 pio;
612         u32 dma;
613 } __packed;
614
615 struct ata_acpi_gtm {
616         struct ata_acpi_drive drive[2];
617         u32 flags;
618 } __packed;
619
620 struct ata_link {
621         struct ata_port         *ap;
622         int                     pmp;            /* port multiplier port # */
623
624         unsigned int            active_tag;     /* active tag on this link */
625         u32                     sactive;        /* active NCQ commands */
626
627         unsigned int            flags;          /* ATA_LFLAG_xxx */
628
629         unsigned int            hw_sata_spd_limit;
630         unsigned int            sata_spd_limit;
631         unsigned int            sata_spd;       /* current SATA PHY speed */
632
633         /* record runtime error info, protected by host_set lock */
634         struct ata_eh_info      eh_info;
635         /* EH context */
636         struct ata_eh_context   eh_context;
637
638         struct ata_device       device[ATA_MAX_DEVICES];
639 };
640
641 struct ata_port {
642         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
643         struct ata_port_operations *ops;
644         spinlock_t              *lock;
645         unsigned long           flags;  /* ATA_FLAG_xxx */
646         unsigned int            pflags; /* ATA_PFLAG_xxx */
647         unsigned int            print_id; /* user visible unique port ID */
648         unsigned int            port_no; /* 0 based port no. inside the host */
649
650         struct ata_prd          *prd;    /* our SG list */
651         dma_addr_t              prd_dma; /* and its DMA mapping */
652
653 #ifdef CONFIG_ATA_SFF
654         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
655 #endif /* CONFIG_ATA_SFF */
656
657         u8                      ctl;    /* cache of ATA control register */
658         u8                      last_ctl;       /* Cache last written value */
659         unsigned int            pio_mask;
660         unsigned int            mwdma_mask;
661         unsigned int            udma_mask;
662         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
663
664         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
665         unsigned long           qc_allocated;
666         unsigned int            qc_active;
667         int                     nr_active_links; /* #links with active qcs */
668
669         struct ata_link         link;   /* host default link */
670
671         int                     nr_pmp_links;   /* nr of available PMP links */
672         struct ata_link         *pmp_link;      /* array of PMP links */
673         struct ata_link         *excl_link;     /* for PMP qc exclusion */
674
675         struct ata_port_stats   stats;
676         struct ata_host         *host;
677         struct device           *dev;
678
679         void                    *port_task_data;
680         struct delayed_work     port_task;
681         struct delayed_work     hotplug_task;
682         struct work_struct      scsi_rescan_task;
683
684         unsigned int            hsm_task_state;
685
686         u32                     msg_enable;
687         struct list_head        eh_done_q;
688         wait_queue_head_t       eh_wait_q;
689         int                     eh_tries;
690
691         pm_message_t            pm_mesg;
692         int                     *pm_result;
693         enum link_pm            pm_policy;
694
695         struct timer_list       fastdrain_timer;
696         unsigned long           fastdrain_cnt;
697
698         void                    *private_data;
699
700 #ifdef CONFIG_ATA_ACPI
701         acpi_handle             acpi_handle;
702         struct ata_acpi_gtm     __acpi_init_gtm; /* use ata_acpi_init_gtm() */
703 #endif
704         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
705 };
706
707 /* The following initializer overrides a method to NULL whether one of
708  * its parent has the method defined or not.  This is equivalent to
709  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
710  * expression and thus can't be used as an initializer.
711  */
712 #define ATA_OP_NULL             (void *)(unsigned long)(-ENOENT)
713
714 struct ata_port_operations {
715         /*
716          * Command execution
717          */
718         int  (*qc_defer)(struct ata_queued_cmd *qc);
719         int  (*check_atapi_dma)(struct ata_queued_cmd *qc);
720         void (*qc_prep)(struct ata_queued_cmd *qc);
721         unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
722         bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
723
724         /*
725          * Configuration and exception handling
726          */
727         int  (*cable_detect)(struct ata_port *ap);
728         unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
729         void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
730         void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
731         int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
732
733         void (*dev_config)(struct ata_device *dev);
734
735         void (*freeze)(struct ata_port *ap);
736         void (*thaw)(struct ata_port *ap);
737         ata_prereset_fn_t       prereset;
738         ata_reset_fn_t          softreset;
739         ata_reset_fn_t          hardreset;
740         ata_postreset_fn_t      postreset;
741         ata_prereset_fn_t       pmp_prereset;
742         ata_reset_fn_t          pmp_softreset;
743         ata_reset_fn_t          pmp_hardreset;
744         ata_postreset_fn_t      pmp_postreset;
745         void (*error_handler)(struct ata_port *ap);
746         void (*post_internal_cmd)(struct ata_queued_cmd *qc);
747
748         /*
749          * Optional features
750          */
751         int  (*scr_read)(struct ata_port *ap, unsigned int sc_reg, u32 *val);
752         int  (*scr_write)(struct ata_port *ap, unsigned int sc_reg, u32 val);
753         void (*pmp_attach)(struct ata_port *ap);
754         void (*pmp_detach)(struct ata_port *ap);
755         int  (*enable_pm)(struct ata_port *ap, enum link_pm policy);
756         void (*disable_pm)(struct ata_port *ap);
757
758         /*
759          * Start, stop, suspend and resume
760          */
761         int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
762         int  (*port_resume)(struct ata_port *ap);
763         int  (*port_start)(struct ata_port *ap);
764         void (*port_stop)(struct ata_port *ap);
765         void (*host_stop)(struct ata_host *host);
766
767 #ifdef CONFIG_ATA_SFF
768         /*
769          * SFF / taskfile oriented ops
770          */
771         void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
772         u8   (*sff_check_status)(struct ata_port *ap);
773         u8   (*sff_check_altstatus)(struct ata_port *ap);
774         void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
775         void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
776         void (*sff_exec_command)(struct ata_port *ap,
777                                  const struct ata_taskfile *tf);
778         unsigned int (*sff_data_xfer)(struct ata_device *dev,
779                         unsigned char *buf, unsigned int buflen, int rw);
780         u8   (*sff_irq_on)(struct ata_port *);
781         void (*sff_irq_clear)(struct ata_port *);
782
783         void (*bmdma_setup)(struct ata_queued_cmd *qc);
784         void (*bmdma_start)(struct ata_queued_cmd *qc);
785         void (*bmdma_stop)(struct ata_queued_cmd *qc);
786         u8   (*bmdma_status)(struct ata_port *ap);
787 #endif /* CONFIG_ATA_SFF */
788
789         /*
790          * Obsolete
791          */
792         void (*phy_reset)(struct ata_port *ap);
793         void (*eng_timeout)(struct ata_port *ap);
794
795         /*
796          * ->inherits must be the last field and all the preceding
797          * fields must be pointers.
798          */
799         const struct ata_port_operations        *inherits;
800 };
801
802 struct ata_port_info {
803         unsigned long           flags;
804         unsigned long           link_flags;
805         unsigned long           pio_mask;
806         unsigned long           mwdma_mask;
807         unsigned long           udma_mask;
808         struct ata_port_operations *port_ops;
809         void                    *private_data;
810 };
811
812 struct ata_timing {
813         unsigned short mode;            /* ATA mode */
814         unsigned short setup;           /* t1 */
815         unsigned short act8b;           /* t2 for 8-bit I/O */
816         unsigned short rec8b;           /* t2i for 8-bit I/O */
817         unsigned short cyc8b;           /* t0 for 8-bit I/O */
818         unsigned short active;          /* t2 or tD */
819         unsigned short recover;         /* t2i or tK */
820         unsigned short cycle;           /* t0 */
821         unsigned short udma;            /* t2CYCTYP/2 */
822 };
823
824 /*
825  * Core layer - drivers/ata/libata-core.c
826  */
827 extern const unsigned long sata_deb_timing_normal[];
828 extern const unsigned long sata_deb_timing_hotplug[];
829 extern const unsigned long sata_deb_timing_long[];
830
831 extern struct ata_port_operations ata_dummy_port_ops;
832 extern const struct ata_port_info ata_dummy_port_info;
833
834 static inline const unsigned long *
835 sata_ehc_deb_timing(struct ata_eh_context *ehc)
836 {
837         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
838                 return sata_deb_timing_hotplug;
839         else
840                 return sata_deb_timing_normal;
841 }
842
843 static inline int ata_port_is_dummy(struct ata_port *ap)
844 {
845         return ap->ops == &ata_dummy_port_ops;
846 }
847
848 extern void ata_port_probe(struct ata_port *);
849 extern int sata_set_spd(struct ata_link *link);
850 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
851 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
852                                 int (*check_ready)(struct ata_link *link));
853 extern int sata_link_debounce(struct ata_link *link,
854                         const unsigned long *params, unsigned long deadline);
855 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
856                             unsigned long deadline);
857 extern int sata_link_hardreset(struct ata_link *link,
858                         const unsigned long *timing, unsigned long deadline,
859                         bool *online, int (*check_ready)(struct ata_link *));
860 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
861                               unsigned long deadline);
862 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
863 extern void ata_port_disable(struct ata_port *);
864
865 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
866 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
867                         const struct ata_port_info * const * ppi, int n_ports);
868 extern int ata_host_start(struct ata_host *host);
869 extern int ata_host_register(struct ata_host *host,
870                              struct scsi_host_template *sht);
871 extern int ata_host_activate(struct ata_host *host, int irq,
872                              irq_handler_t irq_handler, unsigned long irq_flags,
873                              struct scsi_host_template *sht);
874 extern void ata_host_detach(struct ata_host *host);
875 extern void ata_host_init(struct ata_host *, struct device *,
876                           unsigned long, struct ata_port_operations *);
877 extern int ata_scsi_detect(struct scsi_host_template *sht);
878 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
879 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
880 extern void ata_sas_port_destroy(struct ata_port *);
881 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
882                                            struct ata_port_info *, struct Scsi_Host *);
883 extern int ata_sas_port_init(struct ata_port *);
884 extern int ata_sas_port_start(struct ata_port *ap);
885 extern void ata_sas_port_stop(struct ata_port *ap);
886 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
887 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
888                             struct ata_port *ap);
889 extern int sata_scr_valid(struct ata_link *link);
890 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
891 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
892 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
893 extern int ata_link_online(struct ata_link *link);
894 extern int ata_link_offline(struct ata_link *link);
895 #ifdef CONFIG_PM
896 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
897 extern void ata_host_resume(struct ata_host *host);
898 #endif
899 extern int ata_ratelimit(void);
900 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
901                              unsigned long interval, unsigned long timeout);
902 extern int atapi_cmd_type(u8 opcode);
903 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
904                           u8 pmp, int is_cmd, u8 *fis);
905 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
906 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
907                         unsigned long mwdma_mask, unsigned long udma_mask);
908 extern void ata_unpack_xfermask(unsigned long xfer_mask,
909                         unsigned long *pio_mask, unsigned long *mwdma_mask,
910                         unsigned long *udma_mask);
911 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
912 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
913 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
914 extern const char *ata_mode_string(unsigned long xfer_mask);
915 extern unsigned long ata_id_xfermask(const u16 *id);
916 extern int ata_port_start(struct ata_port *ap);
917 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
918 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
919 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
920                  unsigned int n_elem);
921 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
922 extern void ata_dev_disable(struct ata_device *adev);
923 extern void ata_id_string(const u16 *id, unsigned char *s,
924                           unsigned int ofs, unsigned int len);
925 extern void ata_id_c_string(const u16 *id, unsigned char *s,
926                             unsigned int ofs, unsigned int len);
927 extern void ata_qc_complete(struct ata_queued_cmd *qc);
928 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
929 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
930                               void (*done)(struct scsi_cmnd *));
931 extern int ata_std_bios_param(struct scsi_device *sdev,
932                               struct block_device *bdev,
933                               sector_t capacity, int geom[]);
934 extern int ata_scsi_slave_config(struct scsi_device *sdev);
935 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
936 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
937                                        int queue_depth);
938 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
939 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
940
941 extern int ata_cable_40wire(struct ata_port *ap);
942 extern int ata_cable_80wire(struct ata_port *ap);
943 extern int ata_cable_sata(struct ata_port *ap);
944 extern int ata_cable_ignore(struct ata_port *ap);
945 extern int ata_cable_unknown(struct ata_port *ap);
946
947 /* Timing helpers */
948 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
949 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
950 extern int ata_timing_compute(struct ata_device *, unsigned short,
951                               struct ata_timing *, int, int);
952 extern void ata_timing_merge(const struct ata_timing *,
953                              const struct ata_timing *, struct ata_timing *,
954                              unsigned int);
955 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
956
957 /* PCI */
958 #ifdef CONFIG_PCI
959 struct pci_dev;
960
961 struct pci_bits {
962         unsigned int            reg;    /* PCI config register to read */
963         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
964         unsigned long           mask;
965         unsigned long           val;
966 };
967
968 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
969 extern void ata_pci_remove_one(struct pci_dev *pdev);
970
971 #ifdef CONFIG_PM
972 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
973 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
974 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
975 extern int ata_pci_device_resume(struct pci_dev *pdev);
976 #endif /* CONFIG_PM */
977 #endif /* CONFIG_PCI */
978
979 /*
980  * ACPI - drivers/ata/libata-acpi.c
981  */
982 #ifdef CONFIG_ATA_ACPI
983 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
984 {
985         if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
986                 return &ap->__acpi_init_gtm;
987         return NULL;
988 }
989 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
990 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
991 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
992                                     const struct ata_acpi_gtm *gtm);
993 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
994 #else
995 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
996 {
997         return NULL;
998 }
999
1000 static inline int ata_acpi_stm(const struct ata_port *ap,
1001                                struct ata_acpi_gtm *stm)
1002 {
1003         return -ENOSYS;
1004 }
1005
1006 static inline int ata_acpi_gtm(const struct ata_port *ap,
1007                                struct ata_acpi_gtm *stm)
1008 {
1009         return -ENOSYS;
1010 }
1011
1012 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1013                                         const struct ata_acpi_gtm *gtm)
1014 {
1015         return 0;
1016 }
1017
1018 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1019                                       const struct ata_acpi_gtm *gtm)
1020 {
1021         return 0;
1022 }
1023 #endif
1024
1025 /*
1026  * EH - drivers/ata/libata-eh.c
1027  */
1028 extern void ata_port_schedule_eh(struct ata_port *ap);
1029 extern int ata_link_abort(struct ata_link *link);
1030 extern int ata_port_abort(struct ata_port *ap);
1031 extern int ata_port_freeze(struct ata_port *ap);
1032 extern int sata_async_notification(struct ata_port *ap);
1033
1034 extern void ata_eh_freeze_port(struct ata_port *ap);
1035 extern void ata_eh_thaw_port(struct ata_port *ap);
1036
1037 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1038 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1039 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1040
1041 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1042                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1043                       ata_postreset_fn_t postreset);
1044 extern void ata_std_error_handler(struct ata_port *ap);
1045
1046 /*
1047  * Base operations to inherit from and initializers for sht
1048  *
1049  * Operations
1050  *
1051  * base  : Common to all libata drivers.
1052  * sata  : SATA controllers w/ native interface.
1053  * pmp   : SATA controllers w/ PMP support.
1054  * sff   : SFF ATA controllers w/o BMDMA support.
1055  * bmdma : SFF ATA controllers w/ BMDMA support.
1056  *
1057  * sht initializers
1058  *
1059  * BASE  : Common to all libata drivers.  The user must set
1060  *         sg_tablesize and dma_boundary.
1061  * PIO   : SFF ATA controllers w/ only PIO support.
1062  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1063  *         dma_boundary are set to BMDMA limits.
1064  * NCQ   : SATA controllers supporting NCQ.  The user must set
1065  *         sg_tablesize, dma_boundary and can_queue.
1066  */
1067 extern const struct ata_port_operations ata_base_port_ops;
1068 extern const struct ata_port_operations sata_port_ops;
1069
1070 #define ATA_BASE_SHT(drv_name)                                  \
1071         .module                 = THIS_MODULE,                  \
1072         .name                   = drv_name,                     \
1073         .ioctl                  = ata_scsi_ioctl,               \
1074         .queuecommand           = ata_scsi_queuecmd,            \
1075         .can_queue              = ATA_DEF_QUEUE,                \
1076         .this_id                = ATA_SHT_THIS_ID,              \
1077         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,          \
1078         .emulated               = ATA_SHT_EMULATED,             \
1079         .use_clustering         = ATA_SHT_USE_CLUSTERING,       \
1080         .proc_name              = drv_name,                     \
1081         .slave_configure        = ata_scsi_slave_config,        \
1082         .slave_destroy          = ata_scsi_slave_destroy,       \
1083         .bios_param             = ata_std_bios_param
1084
1085 #define ATA_NCQ_SHT(drv_name)                                   \
1086         ATA_BASE_SHT(drv_name),                                 \
1087         .change_queue_depth     = ata_scsi_change_queue_depth
1088
1089 /*
1090  * PMP helpers
1091  */
1092 #ifdef CONFIG_SATA_PMP
1093 static inline bool sata_pmp_supported(struct ata_port *ap)
1094 {
1095         return ap->flags & ATA_FLAG_PMP;
1096 }
1097
1098 static inline bool sata_pmp_attached(struct ata_port *ap)
1099 {
1100         return ap->nr_pmp_links != 0;
1101 }
1102
1103 static inline int ata_is_host_link(const struct ata_link *link)
1104 {
1105         return link == &link->ap->link;
1106 }
1107 #else /* CONFIG_SATA_PMP */
1108 static inline bool sata_pmp_supported(struct ata_port *ap)
1109 {
1110         return false;
1111 }
1112
1113 static inline bool sata_pmp_attached(struct ata_port *ap)
1114 {
1115         return false;
1116 }
1117
1118 static inline int ata_is_host_link(const struct ata_link *link)
1119 {
1120         return 1;
1121 }
1122 #endif /* CONFIG_SATA_PMP */
1123
1124 static inline int sata_srst_pmp(struct ata_link *link)
1125 {
1126         if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1127                 return SATA_PMP_CTRL_PORT;
1128         return link->pmp;
1129 }
1130
1131 /*
1132  * printk helpers
1133  */
1134 #define ata_port_printk(ap, lv, fmt, args...) \
1135         printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1136
1137 #define ata_link_printk(link, lv, fmt, args...) do { \
1138         if (sata_pmp_attached((link)->ap)) \
1139                 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id,   \
1140                        (link)->pmp , ##args); \
1141         else \
1142                 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1143         } while(0)
1144
1145 #define ata_dev_printk(dev, lv, fmt, args...) \
1146         printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id,      \
1147                (dev)->link->pmp + (dev)->devno , ##args)
1148
1149 /*
1150  * ata_eh_info helpers
1151  */
1152 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1153         __attribute__ ((format (printf, 2, 3)));
1154 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1155         __attribute__ ((format (printf, 2, 3)));
1156 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1157
1158 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1159 {
1160         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1161         ehi->flags |= ATA_EHI_HOTPLUGGED;
1162         ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1163         ehi->err_mask |= AC_ERR_ATA_BUS;
1164 }
1165
1166 /*
1167  * port description helpers
1168  */
1169 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1170         __attribute__ ((format (printf, 2, 3)));
1171 #ifdef CONFIG_PCI
1172 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1173                                const char *name);
1174 #endif
1175
1176 static inline unsigned int ata_tag_valid(unsigned int tag)
1177 {
1178         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1179 }
1180
1181 static inline unsigned int ata_tag_internal(unsigned int tag)
1182 {
1183         return tag == ATA_TAG_INTERNAL;
1184 }
1185
1186 /*
1187  * device helpers
1188  */
1189 static inline unsigned int ata_class_enabled(unsigned int class)
1190 {
1191         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1192                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1193 }
1194
1195 static inline unsigned int ata_class_disabled(unsigned int class)
1196 {
1197         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1198                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1199 }
1200
1201 static inline unsigned int ata_class_absent(unsigned int class)
1202 {
1203         return !ata_class_enabled(class) && !ata_class_disabled(class);
1204 }
1205
1206 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1207 {
1208         return ata_class_enabled(dev->class);
1209 }
1210
1211 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1212 {
1213         return ata_class_disabled(dev->class);
1214 }
1215
1216 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1217 {
1218         return ata_class_absent(dev->class);
1219 }
1220
1221 /*
1222  * link helpers
1223  */
1224 static inline int ata_link_max_devices(const struct ata_link *link)
1225 {
1226         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1227                 return 2;
1228         return 1;
1229 }
1230
1231 static inline int ata_link_active(struct ata_link *link)
1232 {
1233         return ata_tag_valid(link->active_tag) || link->sactive;
1234 }
1235
1236 static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1237 {
1238         if (sata_pmp_attached(ap))
1239                 return ap->pmp_link;
1240         return &ap->link;
1241 }
1242
1243 static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1244 {
1245         struct ata_port *ap = link->ap;
1246
1247         if (ata_is_host_link(link)) {
1248                 if (!sata_pmp_attached(ap))
1249                         return NULL;
1250                 return ap->pmp_link;
1251         }
1252
1253         if (++link < ap->nr_pmp_links + ap->pmp_link)
1254                 return link;
1255         return NULL;
1256 }
1257
1258 #define __ata_port_for_each_link(lk, ap) \
1259         for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1260
1261 #define ata_port_for_each_link(link, ap) \
1262         for ((link) = ata_port_first_link(ap); (link); \
1263              (link) = ata_port_next_link(link))
1264
1265 #define ata_link_for_each_dev(dev, link) \
1266         for ((dev) = (link)->device; \
1267              (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1268              (dev)++)
1269
1270 #define ata_link_for_each_dev_reverse(dev, link) \
1271         for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1272              (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1273
1274 /**
1275  *      ata_ncq_enabled - Test whether NCQ is enabled
1276  *      @dev: ATA device to test for
1277  *
1278  *      LOCKING:
1279  *      spin_lock_irqsave(host lock)
1280  *
1281  *      RETURNS:
1282  *      1 if NCQ is enabled for @dev, 0 otherwise.
1283  */
1284 static inline int ata_ncq_enabled(struct ata_device *dev)
1285 {
1286         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1287                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1288 }
1289
1290 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1291 {
1292         qc->tf.ctl |= ATA_NIEN;
1293 }
1294
1295 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1296                                                        unsigned int tag)
1297 {
1298         if (likely(ata_tag_valid(tag)))
1299                 return &ap->qcmd[tag];
1300         return NULL;
1301 }
1302
1303 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1304                                                      unsigned int tag)
1305 {
1306         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1307
1308         if (unlikely(!qc) || !ap->ops->error_handler)
1309                 return qc;
1310
1311         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1312                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1313                 return qc;
1314
1315         return NULL;
1316 }
1317
1318 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1319 {
1320         return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1321 }
1322
1323 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1324 {
1325         memset(tf, 0, sizeof(*tf));
1326
1327         tf->ctl = dev->link->ap->ctl;
1328         if (dev->devno == 0)
1329                 tf->device = ATA_DEVICE_OBS;
1330         else
1331                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1332 }
1333
1334 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1335 {
1336         qc->dma_dir = DMA_NONE;
1337         qc->sg = NULL;
1338         qc->flags = 0;
1339         qc->cursg = NULL;
1340         qc->cursg_ofs = 0;
1341         qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1342         qc->n_elem = 0;
1343         qc->err_mask = 0;
1344         qc->sect_size = ATA_SECT_SIZE;
1345
1346         ata_tf_init(qc->dev, &qc->tf);
1347
1348         /* init result_tf such that it indicates normal completion */
1349         qc->result_tf.command = ATA_DRDY;
1350         qc->result_tf.feature = 0;
1351 }
1352
1353 static inline int ata_try_flush_cache(const struct ata_device *dev)
1354 {
1355         return ata_id_wcache_enabled(dev->id) ||
1356                ata_id_has_flush(dev->id) ||
1357                ata_id_has_flush_ext(dev->id);
1358 }
1359
1360 static inline unsigned int ac_err_mask(u8 status)
1361 {
1362         if (status & (ATA_BUSY | ATA_DRQ))
1363                 return AC_ERR_HSM;
1364         if (status & (ATA_ERR | ATA_DF))
1365                 return AC_ERR_DEV;
1366         return 0;
1367 }
1368
1369 static inline unsigned int __ac_err_mask(u8 status)
1370 {
1371         unsigned int mask = ac_err_mask(status);
1372         if (mask == 0)
1373                 return AC_ERR_OTHER;
1374         return mask;
1375 }
1376
1377 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1378 {
1379         return *(struct ata_port **)&host->hostdata[0];
1380 }
1381
1382 static inline int ata_check_ready(u8 status)
1383 {
1384         if (!(status & ATA_BUSY))
1385                 return 1;
1386
1387         /* 0xff indicates either no device or device not ready */
1388         if (status == 0xff)
1389                 return -ENODEV;
1390
1391         return 0;
1392 }
1393
1394 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1395                                          unsigned long timeout_msecs)
1396 {
1397         return from_jiffies + msecs_to_jiffies(timeout_msecs);
1398 }
1399
1400
1401 /**************************************************************************
1402  * PMP - drivers/ata/libata-pmp.c
1403  */
1404 #ifdef CONFIG_SATA_PMP
1405
1406 extern const struct ata_port_operations sata_pmp_port_ops;
1407
1408 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1409 extern void sata_pmp_error_handler(struct ata_port *ap);
1410
1411 #else /* CONFIG_SATA_PMP */
1412
1413 #define sata_pmp_port_ops               sata_port_ops
1414 #define sata_pmp_qc_defer_cmd_switch    ata_std_qc_defer
1415 #define sata_pmp_error_handler          ata_std_error_handler
1416
1417 #endif /* CONFIG_SATA_PMP */
1418
1419
1420 /**************************************************************************
1421  * SFF - drivers/ata/libata-sff.c
1422  */
1423 #ifdef CONFIG_ATA_SFF
1424
1425 extern const struct ata_port_operations ata_sff_port_ops;
1426 extern const struct ata_port_operations ata_bmdma_port_ops;
1427
1428 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1429 #define ATA_PIO_SHT(drv_name)                                   \
1430         ATA_BASE_SHT(drv_name),                                 \
1431         .sg_tablesize           = LIBATA_MAX_PRD,               \
1432         .dma_boundary           = ATA_DMA_BOUNDARY
1433
1434 #define ATA_BMDMA_SHT(drv_name)                                 \
1435         ATA_BASE_SHT(drv_name),                                 \
1436         .sg_tablesize           = LIBATA_MAX_PRD,               \
1437         .dma_boundary           = ATA_DMA_BOUNDARY
1438
1439 extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1440 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1441 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1442 extern u8 ata_sff_check_status(struct ata_port *ap);
1443 extern void ata_sff_pause(struct ata_port *ap);
1444 extern void ata_sff_dma_pause(struct ata_port *ap);
1445 extern int ata_sff_busy_sleep(struct ata_port *ap,
1446                               unsigned long timeout_pat, unsigned long timeout);
1447 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1448 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1449 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1450 extern void ata_sff_exec_command(struct ata_port *ap,
1451                                  const struct ata_taskfile *tf);
1452 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1453                         unsigned char *buf, unsigned int buflen, int rw);
1454 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1455                         unsigned char *buf, unsigned int buflen, int rw);
1456 extern u8 ata_sff_irq_on(struct ata_port *ap);
1457 extern void ata_sff_irq_clear(struct ata_port *ap);
1458 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1459                             u8 status, int in_wq);
1460 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1461 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1462 extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1463                                       struct ata_queued_cmd *qc);
1464 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1465 extern void ata_sff_freeze(struct ata_port *ap);
1466 extern void ata_sff_thaw(struct ata_port *ap);
1467 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1468 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1469                                           u8 *r_err);
1470 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1471                                     unsigned long deadline);
1472 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1473                              unsigned long deadline);
1474 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1475                                unsigned long deadline);
1476 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1477 extern void ata_sff_error_handler(struct ata_port *ap);
1478 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
1479 extern int ata_sff_port_start(struct ata_port *ap);
1480 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1481 extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1482                                            unsigned long xfer_mask);
1483 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1484 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1485 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1486 extern u8 ata_bmdma_status(struct ata_port *ap);
1487 extern void ata_bus_reset(struct ata_port *ap);
1488
1489 #ifdef CONFIG_PCI
1490 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1491 extern int ata_pci_bmdma_init(struct ata_host *host);
1492 extern int ata_pci_sff_init_host(struct ata_host *host);
1493 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1494                                     const struct ata_port_info * const * ppi,
1495                                     struct ata_host **r_host);
1496 extern int ata_pci_sff_activate_host(struct ata_host *host,
1497                                      irq_handler_t irq_handler,
1498                                      struct scsi_host_template *sht);
1499 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1500                                 const struct ata_port_info * const * ppi,
1501                                 struct scsi_host_template *sht, void *host_priv);
1502 #endif /* CONFIG_PCI */
1503
1504 /**
1505  *      ata_sff_busy_wait - Wait for a port status register
1506  *      @ap: Port to wait for.
1507  *      @bits: bits that must be clear
1508  *      @max: number of 10uS waits to perform
1509  *
1510  *      Waits up to max*10 microseconds for the selected bits in the port's
1511  *      status register to be cleared.
1512  *      Returns final value of status register.
1513  *
1514  *      LOCKING:
1515  *      Inherited from caller.
1516  */
1517 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1518                                    unsigned int max)
1519 {
1520         u8 status;
1521
1522         do {
1523                 udelay(10);
1524                 status = ap->ops->sff_check_status(ap);
1525                 max--;
1526         } while (status != 0xff && (status & bits) && (max > 0));
1527
1528         return status;
1529 }
1530
1531 /**
1532  *      ata_wait_idle - Wait for a port to be idle.
1533  *      @ap: Port to wait for.
1534  *
1535  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1536  *      Returns final value of status register.
1537  *
1538  *      LOCKING:
1539  *      Inherited from caller.
1540  */
1541 static inline u8 ata_wait_idle(struct ata_port *ap)
1542 {
1543         u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1544
1545 #ifdef ATA_DEBUG
1546         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1547                 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1548                                 status);
1549 #endif
1550
1551         return status;
1552 }
1553 #endif /* CONFIG_ATA_SFF */
1554
1555 #endif /* __LINUX_LIBATA_H__ */