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