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