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