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