GNU Linux-libre 4.19.209-gnu1
[releases.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/driver-api/libata.rst
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 #include <linux/sched.h>
41 #include <linux/async.h>
42
43 /*
44  * Define if arch has non-standard setup.  This is a _PCI_ standard
45  * not a legacy or ISA standard.
46  */
47 #ifdef CONFIG_ATA_NONSTANDARD
48 #include <asm/libata-portmap.h>
49 #else
50 #define ATA_PRIMARY_IRQ(dev)    14
51 #define ATA_SECONDARY_IRQ(dev)  15
52 #endif
53
54 /*
55  * compile-time options: to be removed as soon as all the drivers are
56  * converted to the new debugging mechanism
57  */
58 #undef ATA_DEBUG                /* debugging output */
59 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
60 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
61 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
62
63
64 /* note: prints function name for you */
65 #ifdef ATA_DEBUG
66 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
67 #ifdef ATA_VERBOSE_DEBUG
68 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
69 #else
70 #define VPRINTK(fmt, args...)
71 #endif  /* ATA_VERBOSE_DEBUG */
72 #else
73 #define DPRINTK(fmt, args...)
74 #define VPRINTK(fmt, args...)
75 #endif  /* ATA_DEBUG */
76
77 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
78
79 #define ata_print_version_once(dev, version)                    \
80 ({                                                              \
81         static bool __print_once;                               \
82                                                                 \
83         if (!__print_once) {                                    \
84                 __print_once = true;                            \
85                 ata_print_version(dev, version);                \
86         }                                                       \
87 })
88
89 /* NEW: debug levels */
90 #define HAVE_LIBATA_MSG 1
91
92 enum {
93         ATA_MSG_DRV     = 0x0001,
94         ATA_MSG_INFO    = 0x0002,
95         ATA_MSG_PROBE   = 0x0004,
96         ATA_MSG_WARN    = 0x0008,
97         ATA_MSG_MALLOC  = 0x0010,
98         ATA_MSG_CTL     = 0x0020,
99         ATA_MSG_INTR    = 0x0040,
100         ATA_MSG_ERR     = 0x0080,
101 };
102
103 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
104 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
105 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
106 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
107 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
108 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
109 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
110 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
111
112 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
113 {
114         if (dval < 0 || dval >= (sizeof(u32) * 8))
115                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
116         if (!dval)
117                 return 0;
118         return (1 << dval) - 1;
119 }
120
121 /* defines only for the constants which don't work well as enums */
122 #define ATA_TAG_POISON          0xfafbfcfdU
123
124 enum {
125         /* various global constants */
126         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
127         LIBATA_DUMB_MAX_PRD     = ATA_MAX_PRD / 4,      /* Worst case */
128         ATA_DEF_QUEUE           = 1,
129         ATA_MAX_QUEUE           = 32,
130         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE,
131         ATA_SHORT_PAUSE         = 16,
132
133         ATAPI_MAX_DRAIN         = 16 << 10,
134
135         ATA_ALL_DEVICES         = (1 << ATA_MAX_DEVICES) - 1,
136
137         ATA_SHT_EMULATED        = 1,
138         ATA_SHT_THIS_ID         = -1,
139         ATA_SHT_USE_CLUSTERING  = 1,
140
141         /* struct ata_taskfile flags */
142         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
143         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
144         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
145         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
146         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
147         ATA_TFLAG_FUA           = (1 << 5), /* enable FUA */
148         ATA_TFLAG_POLLING       = (1 << 6), /* set nIEN to 1 and use polling */
149
150         /* struct ata_device stuff */
151         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
152         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
153         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
154         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
155         ATA_DFLAG_FLUSH_EXT     = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
156         ATA_DFLAG_ACPI_PENDING  = (1 << 5), /* ACPI resume action pending */
157         ATA_DFLAG_ACPI_FAILED   = (1 << 6), /* ACPI on devcfg has failed */
158         ATA_DFLAG_AN            = (1 << 7), /* AN configured */
159         ATA_DFLAG_TRUSTED       = (1 << 8), /* device supports trusted send/recv */
160         ATA_DFLAG_DMADIR        = (1 << 10), /* device requires DMADIR */
161         ATA_DFLAG_CFG_MASK      = (1 << 12) - 1,
162
163         ATA_DFLAG_PIO           = (1 << 12), /* device limited to PIO mode */
164         ATA_DFLAG_NCQ_OFF       = (1 << 13), /* device limited to non-NCQ mode */
165         ATA_DFLAG_SLEEPING      = (1 << 15), /* device is sleeping */
166         ATA_DFLAG_DUBIOUS_XFER  = (1 << 16), /* data transfer not verified */
167         ATA_DFLAG_NO_UNLOAD     = (1 << 17), /* device doesn't support unload */
168         ATA_DFLAG_UNLOCK_HPA    = (1 << 18), /* unlock HPA */
169         ATA_DFLAG_NCQ_SEND_RECV = (1 << 19), /* device supports NCQ SEND and RECV */
170         ATA_DFLAG_NCQ_PRIO      = (1 << 20), /* device supports NCQ priority */
171         ATA_DFLAG_NCQ_PRIO_ENABLE = (1 << 21), /* Priority cmds sent to dev */
172         ATA_DFLAG_INIT_MASK     = (1 << 24) - 1,
173
174         ATA_DFLAG_DETACH        = (1 << 24),
175         ATA_DFLAG_DETACHED      = (1 << 25),
176
177         ATA_DFLAG_DA            = (1 << 26), /* device supports Device Attention */
178         ATA_DFLAG_DEVSLP        = (1 << 27), /* device supports Device Sleep */
179         ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
180         ATA_DFLAG_D_SENSE       = (1 << 29), /* Descriptor sense requested */
181         ATA_DFLAG_ZAC           = (1 << 30), /* ZAC device */
182
183         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
184         ATA_DEV_ATA             = 1,    /* ATA device */
185         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
186         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
187         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
188         ATA_DEV_PMP             = 5,    /* SATA port multiplier */
189         ATA_DEV_PMP_UNSUP       = 6,    /* SATA port multiplier (unsupported) */
190         ATA_DEV_SEMB            = 7,    /* SEMB */
191         ATA_DEV_SEMB_UNSUP      = 8,    /* SEMB (unsupported) */
192         ATA_DEV_ZAC             = 9,    /* ZAC device */
193         ATA_DEV_ZAC_UNSUP       = 10,   /* ZAC device (unsupported) */
194         ATA_DEV_NONE            = 11,   /* no device */
195
196         /* struct ata_link flags */
197         ATA_LFLAG_NO_HRST       = (1 << 1), /* avoid hardreset */
198         ATA_LFLAG_NO_SRST       = (1 << 2), /* avoid softreset */
199         ATA_LFLAG_ASSUME_ATA    = (1 << 3), /* assume ATA class */
200         ATA_LFLAG_ASSUME_SEMB   = (1 << 4), /* assume SEMB class */
201         ATA_LFLAG_ASSUME_CLASS  = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
202         ATA_LFLAG_NO_RETRY      = (1 << 5), /* don't retry this link */
203         ATA_LFLAG_DISABLED      = (1 << 6), /* link is disabled */
204         ATA_LFLAG_SW_ACTIVITY   = (1 << 7), /* keep activity stats */
205         ATA_LFLAG_NO_LPM        = (1 << 8), /* disable LPM on this link */
206         ATA_LFLAG_RST_ONCE      = (1 << 9), /* limit recovery to one reset */
207         ATA_LFLAG_CHANGED       = (1 << 10), /* LPM state changed on this link */
208         ATA_LFLAG_NO_DB_DELAY   = (1 << 11), /* no debounce delay on link resume */
209
210         /* struct ata_port flags */
211         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
212                                             /* (doesn't imply presence) */
213         ATA_FLAG_SATA           = (1 << 1),
214         ATA_FLAG_NO_LPM         = (1 << 2), /* host not happy with LPM */
215         ATA_FLAG_NO_LOG_PAGE    = (1 << 5), /* do not issue log page read */
216         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
217         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
218         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
219         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
220                                              * doesn't handle PIO interrupts */
221         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
222         ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
223         ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
224         ATA_FLAG_DEBUGMSG       = (1 << 13),
225         ATA_FLAG_FPDMA_AA               = (1 << 14), /* driver supports Auto-Activate */
226         ATA_FLAG_IGN_SIMPLEX    = (1 << 15), /* ignore SIMPLEX */
227         ATA_FLAG_NO_IORDY       = (1 << 16), /* controller lacks iordy */
228         ATA_FLAG_ACPI_SATA      = (1 << 17), /* need native SATA ACPI layout */
229         ATA_FLAG_AN             = (1 << 18), /* controller supports AN */
230         ATA_FLAG_PMP            = (1 << 19), /* controller supports PMP */
231         ATA_FLAG_FPDMA_AUX      = (1 << 20), /* controller supports H2DFIS aux field */
232         ATA_FLAG_EM             = (1 << 21), /* driver supports enclosure
233                                               * management */
234         ATA_FLAG_SW_ACTIVITY    = (1 << 22), /* driver supports sw activity
235                                               * led */
236         ATA_FLAG_NO_DIPM        = (1 << 23), /* host not happy with DIPM */
237         ATA_FLAG_SAS_HOST       = (1 << 24), /* SAS host */
238
239         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
240
241
242         /* struct ata_port pflags */
243         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
244         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
245         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
246         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
247         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
248         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
249         ATA_PFLAG_INITIALIZING  = (1 << 7), /* being initialized, don't touch */
250         ATA_PFLAG_RESETTING     = (1 << 8), /* reset in progress */
251         ATA_PFLAG_UNLOADING     = (1 << 9), /* driver is being unloaded */
252         ATA_PFLAG_UNLOADED      = (1 << 10), /* driver is unloaded */
253
254         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
255         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
256         ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
257
258         ATA_PFLAG_PIO32         = (1 << 20),  /* 32bit PIO */
259         ATA_PFLAG_PIO32CHANGE   = (1 << 21),  /* 32bit PIO can be turned on/off */
260         ATA_PFLAG_EXTERNAL      = (1 << 22),  /* eSATA/external port */
261
262         /* struct ata_queued_cmd flags */
263         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
264         ATA_QCFLAG_DMAMAP       = (1 << 1), /* SG table is DMA mapped */
265         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
266         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
267         ATA_QCFLAG_CLEAR_EXCL   = (1 << 5), /* clear excl_link on completion */
268         ATA_QCFLAG_QUIET        = (1 << 6), /* don't report device error */
269         ATA_QCFLAG_RETRY        = (1 << 7), /* retry after failure */
270
271         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
272         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
273         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
274
275         /* host set flags */
276         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
277         ATA_HOST_STARTED        = (1 << 1),     /* Host started */
278         ATA_HOST_PARALLEL_SCAN  = (1 << 2),     /* Ports on this host can be scanned in parallel */
279         ATA_HOST_IGNORE_ATA     = (1 << 3),     /* Ignore ATA devices on this host. */
280
281         /* bits 24:31 of host->flags are reserved for LLD specific flags */
282
283         /* various lengths of time */
284         ATA_TMOUT_BOOT          = 30000,        /* heuristic */
285         ATA_TMOUT_BOOT_QUICK    =  7000,        /* heuristic */
286         ATA_TMOUT_INTERNAL_QUICK = 5000,
287         ATA_TMOUT_MAX_PARK      = 30000,
288
289         /*
290          * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms.  2s
291          * is too much without parallel probing.  Use 2s if parallel
292          * probing is available, 800ms otherwise.
293          */
294         ATA_TMOUT_FF_WAIT_LONG  =  2000,
295         ATA_TMOUT_FF_WAIT       =   800,
296
297         /* Spec mandates to wait for ">= 2ms" before checking status
298          * after reset.  We wait 150ms, because that was the magic
299          * delay used for ATAPI devices in Hale Landis's ATADRVR, for
300          * the period of time between when the ATA command register is
301          * written, and then status is checked.  Because waiting for
302          * "a while" before checking status is fine, post SRST, we
303          * perform this magic delay here as well.
304          *
305          * Old drivers/ide uses the 2mS rule and then waits for ready.
306          */
307         ATA_WAIT_AFTER_RESET    =  150,
308
309         /* If PMP is supported, we have to do follow-up SRST.  As some
310          * PMPs don't send D2H Reg FIS after hardreset, LLDs are
311          * advised to wait only for the following duration before
312          * doing SRST.
313          */
314         ATA_TMOUT_PMP_SRST_WAIT = 5000,
315
316         /* When the LPM policy is set to ATA_LPM_MAX_POWER, there might
317          * be a spurious PHY event, so ignore the first PHY event that
318          * occurs within 10s after the policy change.
319          */
320         ATA_TMOUT_SPURIOUS_PHY  = 10000,
321
322         /* ATA bus states */
323         BUS_UNKNOWN             = 0,
324         BUS_DMA                 = 1,
325         BUS_IDLE                = 2,
326         BUS_NOINTR              = 3,
327         BUS_NODATA              = 4,
328         BUS_TIMER               = 5,
329         BUS_PIO                 = 6,
330         BUS_EDD                 = 7,
331         BUS_IDENTIFY            = 8,
332         BUS_PACKET              = 9,
333
334         /* SATA port states */
335         PORT_UNKNOWN            = 0,
336         PORT_ENABLED            = 1,
337         PORT_DISABLED           = 2,
338
339         /* encoding various smaller bitmaps into a single
340          * unsigned long bitmap
341          */
342         ATA_NR_PIO_MODES        = 7,
343         ATA_NR_MWDMA_MODES      = 5,
344         ATA_NR_UDMA_MODES       = 8,
345
346         ATA_SHIFT_PIO           = 0,
347         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
348         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
349         ATA_SHIFT_PRIO          = 6,
350
351         ATA_PRIO_HIGH           = 2,
352         /* size of buffer to pad xfers ending on unaligned boundaries */
353         ATA_DMA_PAD_SZ          = 4,
354
355         /* ering size */
356         ATA_ERING_SIZE          = 32,
357
358         /* return values for ->qc_defer */
359         ATA_DEFER_LINK          = 1,
360         ATA_DEFER_PORT          = 2,
361
362         /* desc_len for ata_eh_info and context */
363         ATA_EH_DESC_LEN         = 80,
364
365         /* reset / recovery action types */
366         ATA_EH_REVALIDATE       = (1 << 0),
367         ATA_EH_SOFTRESET        = (1 << 1), /* meaningful only in ->prereset */
368         ATA_EH_HARDRESET        = (1 << 2), /* meaningful only in ->prereset */
369         ATA_EH_RESET            = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
370         ATA_EH_ENABLE_LINK      = (1 << 3),
371         ATA_EH_PARK             = (1 << 5), /* unload heads and stop I/O */
372
373         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE | ATA_EH_PARK,
374         ATA_EH_ALL_ACTIONS      = ATA_EH_REVALIDATE | ATA_EH_RESET |
375                                   ATA_EH_ENABLE_LINK,
376
377         /* ata_eh_info->flags */
378         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
379         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
380         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
381         ATA_EHI_NO_RECOVERY     = (1 << 4),  /* no recovery */
382
383         ATA_EHI_DID_SOFTRESET   = (1 << 16), /* already soft-reset this port */
384         ATA_EHI_DID_HARDRESET   = (1 << 17), /* already soft-reset this port */
385         ATA_EHI_PRINTINFO       = (1 << 18), /* print configuration info */
386         ATA_EHI_SETMODE         = (1 << 19), /* configure transfer mode */
387         ATA_EHI_POST_SETMODE    = (1 << 20), /* revalidating after setmode */
388
389         ATA_EHI_DID_RESET       = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
390
391         /* mask of flags to transfer *to* the slave link */
392         ATA_EHI_TO_SLAVE_MASK   = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
393
394         /* max tries if error condition is still set after ->error_handler */
395         ATA_EH_MAX_TRIES        = 5,
396
397         /* sometimes resuming a link requires several retries */
398         ATA_LINK_RESUME_TRIES   = 5,
399
400         /* how hard are we gonna try to probe/recover devices */
401         ATA_PROBE_MAX_TRIES     = 3,
402         ATA_EH_DEV_TRIES        = 3,
403         ATA_EH_PMP_TRIES        = 5,
404         ATA_EH_PMP_LINK_TRIES   = 3,
405
406         SATA_PMP_RW_TIMEOUT     = 3000,         /* PMP read/write timeout */
407
408         /* This should match the actual table size of
409          * ata_eh_cmd_timeout_table in libata-eh.c.
410          */
411         ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
412
413         /* Horkage types. May be set by libata or controller on drives
414            (some horkage may be drive/controller pair dependent */
415
416         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
417         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
418         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
419         ATA_HORKAGE_MAX_SEC_128 = (1 << 3),     /* Limit max sects to 128 */
420         ATA_HORKAGE_BROKEN_HPA  = (1 << 4),     /* Broken HPA */
421         ATA_HORKAGE_DISABLE     = (1 << 5),     /* Disable it */
422         ATA_HORKAGE_HPA_SIZE    = (1 << 6),     /* native size off by one */
423         ATA_HORKAGE_IVB         = (1 << 8),     /* cbl det validity bit bugs */
424         ATA_HORKAGE_STUCK_ERR   = (1 << 9),     /* stuck ERR on next PACKET */
425         ATA_HORKAGE_BRIDGE_OK   = (1 << 10),    /* no bridge limits */
426         ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
427                                                     not multiple of 16 bytes */
428         ATA_HORKAGE_FIRMWARE_WARN = (1 << 12),  /* firmware update warning */
429         ATA_HORKAGE_1_5_GBPS    = (1 << 13),    /* force 1.5 Gbps */
430         ATA_HORKAGE_NOSETXFER   = (1 << 14),    /* skip SETXFER, SATA only */
431         ATA_HORKAGE_BROKEN_FPDMA_AA     = (1 << 15),    /* skip AA */
432         ATA_HORKAGE_DUMP_ID     = (1 << 16),    /* dump IDENTIFY data */
433         ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17),  /* Set max sects to 65535 */
434         ATA_HORKAGE_ATAPI_DMADIR = (1 << 18),   /* device requires dmadir */
435         ATA_HORKAGE_NO_NCQ_TRIM = (1 << 19),    /* don't use queued TRIM */
436         ATA_HORKAGE_NOLPM       = (1 << 20),    /* don't use LPM */
437         ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21),  /* some WDs have broken LPM */
438         ATA_HORKAGE_ZERO_AFTER_TRIM = (1 << 22),/* guarantees zero after trim */
439         ATA_HORKAGE_NO_DMA_LOG  = (1 << 23),    /* don't use DMA for log read */
440         ATA_HORKAGE_NOTRIM      = (1 << 24),    /* don't use TRIM */
441         ATA_HORKAGE_MAX_SEC_1024 = (1 << 25),   /* Limit max sects to 1024 */
442         ATA_HORKAGE_MAX_TRIM_128M = (1 << 26),  /* Limit max trim size to 128M */
443
444          /* DMA mask for user DMA control: User visible values; DO NOT
445             renumber */
446         ATA_DMA_MASK_ATA        = (1 << 0),     /* DMA on ATA Disk */
447         ATA_DMA_MASK_ATAPI      = (1 << 1),     /* DMA on ATAPI */
448         ATA_DMA_MASK_CFA        = (1 << 2),     /* DMA on CF Card */
449
450         /* ATAPI command types */
451         ATAPI_READ              = 0,            /* READs */
452         ATAPI_WRITE             = 1,            /* WRITEs */
453         ATAPI_READ_CD           = 2,            /* READ CD [MSF] */
454         ATAPI_PASS_THRU         = 3,            /* SAT pass-thru */
455         ATAPI_MISC              = 4,            /* the rest */
456
457         /* Timing constants */
458         ATA_TIMING_SETUP        = (1 << 0),
459         ATA_TIMING_ACT8B        = (1 << 1),
460         ATA_TIMING_REC8B        = (1 << 2),
461         ATA_TIMING_CYC8B        = (1 << 3),
462         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
463                                   ATA_TIMING_CYC8B,
464         ATA_TIMING_ACTIVE       = (1 << 4),
465         ATA_TIMING_RECOVER      = (1 << 5),
466         ATA_TIMING_DMACK_HOLD   = (1 << 6),
467         ATA_TIMING_CYCLE        = (1 << 7),
468         ATA_TIMING_UDMA         = (1 << 8),
469         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
470                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
471                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
472                                   ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
473                                   ATA_TIMING_UDMA,
474
475         /* ACPI constants */
476         ATA_ACPI_FILTER_SETXFER = 1 << 0,
477         ATA_ACPI_FILTER_LOCK    = 1 << 1,
478         ATA_ACPI_FILTER_DIPM    = 1 << 2,
479         ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,  /* FPDMA non-zero offset */
480         ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,      /* FPDMA auto activate */
481
482         ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
483                                   ATA_ACPI_FILTER_LOCK |
484                                   ATA_ACPI_FILTER_DIPM,
485 };
486
487 enum ata_xfer_mask {
488         ATA_MASK_PIO            = ((1LU << ATA_NR_PIO_MODES) - 1)
489                                         << ATA_SHIFT_PIO,
490         ATA_MASK_MWDMA          = ((1LU << ATA_NR_MWDMA_MODES) - 1)
491                                         << ATA_SHIFT_MWDMA,
492         ATA_MASK_UDMA           = ((1LU << ATA_NR_UDMA_MODES) - 1)
493                                         << ATA_SHIFT_UDMA,
494 };
495
496 enum hsm_task_states {
497         HSM_ST_IDLE,            /* no command on going */
498         HSM_ST_FIRST,           /* (waiting the device to)
499                                    write CDB or first data block */
500         HSM_ST,                 /* (waiting the device to) transfer data */
501         HSM_ST_LAST,            /* (waiting the device to) complete command */
502         HSM_ST_ERR,             /* error */
503 };
504
505 enum ata_completion_errors {
506         AC_ERR_OK               = 0,        /* no error */
507         AC_ERR_DEV              = (1 << 0), /* device reported error */
508         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
509         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
510         AC_ERR_MEDIA            = (1 << 3), /* media error */
511         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
512         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
513         AC_ERR_SYSTEM           = (1 << 6), /* system error */
514         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
515         AC_ERR_OTHER            = (1 << 8), /* unknown */
516         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
517         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
518 };
519
520 /*
521  * Link power management policy: If you alter this, you also need to
522  * alter libata-scsi.c (for the ascii descriptions)
523  */
524 enum ata_lpm_policy {
525         ATA_LPM_UNKNOWN,
526         ATA_LPM_MAX_POWER,
527         ATA_LPM_MED_POWER,
528         ATA_LPM_MED_POWER_WITH_DIPM, /* Med power + DIPM as win IRST does */
529         ATA_LPM_MIN_POWER_WITH_PARTIAL, /* Min Power + partial and slumber */
530         ATA_LPM_MIN_POWER, /* Min power + no partial (slumber only) */
531 };
532
533 enum ata_lpm_hints {
534         ATA_LPM_EMPTY           = (1 << 0), /* port empty/probing */
535         ATA_LPM_HIPM            = (1 << 1), /* may use HIPM */
536         ATA_LPM_WAKE_ONLY       = (1 << 2), /* only wake up link */
537 };
538
539 /* forward declarations */
540 struct scsi_device;
541 struct ata_port_operations;
542 struct ata_port;
543 struct ata_link;
544 struct ata_queued_cmd;
545
546 /* typedefs */
547 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
548 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
549 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
550                               unsigned long deadline);
551 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
552
553 extern struct device_attribute dev_attr_link_power_management_policy;
554 extern struct device_attribute dev_attr_unload_heads;
555 extern struct device_attribute dev_attr_ncq_prio_enable;
556 extern struct device_attribute dev_attr_em_message_type;
557 extern struct device_attribute dev_attr_em_message;
558 extern struct device_attribute dev_attr_sw_activity;
559
560 enum sw_activity {
561         OFF,
562         BLINK_ON,
563         BLINK_OFF,
564 };
565
566 struct ata_taskfile {
567         unsigned long           flags;          /* ATA_TFLAG_xxx */
568         u8                      protocol;       /* ATA_PROT_xxx */
569
570         u8                      ctl;            /* control reg */
571
572         u8                      hob_feature;    /* additional data */
573         u8                      hob_nsect;      /* to support LBA48 */
574         u8                      hob_lbal;
575         u8                      hob_lbam;
576         u8                      hob_lbah;
577
578         u8                      feature;
579         u8                      nsect;
580         u8                      lbal;
581         u8                      lbam;
582         u8                      lbah;
583
584         u8                      device;
585
586         u8                      command;        /* IO operation */
587
588         u32                     auxiliary;      /* auxiliary field */
589                                                 /* from SATA 3.1 and */
590                                                 /* ATA-8 ACS-3 */
591 };
592
593 #ifdef CONFIG_ATA_SFF
594 struct ata_ioports {
595         void __iomem            *cmd_addr;
596         void __iomem            *data_addr;
597         void __iomem            *error_addr;
598         void __iomem            *feature_addr;
599         void __iomem            *nsect_addr;
600         void __iomem            *lbal_addr;
601         void __iomem            *lbam_addr;
602         void __iomem            *lbah_addr;
603         void __iomem            *device_addr;
604         void __iomem            *status_addr;
605         void __iomem            *command_addr;
606         void __iomem            *altstatus_addr;
607         void __iomem            *ctl_addr;
608 #ifdef CONFIG_ATA_BMDMA
609         void __iomem            *bmdma_addr;
610 #endif /* CONFIG_ATA_BMDMA */
611         void __iomem            *scr_addr;
612 };
613 #endif /* CONFIG_ATA_SFF */
614
615 struct ata_host {
616         spinlock_t              lock;
617         struct device           *dev;
618         void __iomem * const    *iomap;
619         unsigned int            n_ports;
620         unsigned int            n_tags;                 /* nr of NCQ tags */
621         void                    *private_data;
622         struct ata_port_operations *ops;
623         unsigned long           flags;
624         struct kref             kref;
625
626         struct mutex            eh_mutex;
627         struct task_struct      *eh_owner;
628
629         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
630         struct ata_port         *ports[0];
631 };
632
633 struct ata_queued_cmd {
634         struct ata_port         *ap;
635         struct ata_device       *dev;
636
637         struct scsi_cmnd        *scsicmd;
638         void                    (*scsidone)(struct scsi_cmnd *);
639
640         struct ata_taskfile     tf;
641         u8                      cdb[ATAPI_CDB_LEN];
642
643         unsigned long           flags;          /* ATA_QCFLAG_xxx */
644         unsigned int            tag;            /* libata core tag */
645         unsigned int            hw_tag;         /* driver tag */
646         unsigned int            n_elem;
647         unsigned int            orig_n_elem;
648
649         int                     dma_dir;
650
651         unsigned int            sect_size;
652
653         unsigned int            nbytes;
654         unsigned int            extrabytes;
655         unsigned int            curbytes;
656
657         struct scatterlist      sgent;
658
659         struct scatterlist      *sg;
660
661         struct scatterlist      *cursg;
662         unsigned int            cursg_ofs;
663
664         unsigned int            err_mask;
665         struct ata_taskfile     result_tf;
666         ata_qc_cb_t             complete_fn;
667
668         void                    *private_data;
669         void                    *lldd_task;
670 };
671
672 struct ata_port_stats {
673         unsigned long           unhandled_irq;
674         unsigned long           idle_irq;
675         unsigned long           rw_reqbuf;
676 };
677
678 struct ata_ering_entry {
679         unsigned int            eflags;
680         unsigned int            err_mask;
681         u64                     timestamp;
682 };
683
684 struct ata_ering {
685         int                     cursor;
686         struct ata_ering_entry  ring[ATA_ERING_SIZE];
687 };
688
689 struct ata_device {
690         struct ata_link         *link;
691         unsigned int            devno;          /* 0 or 1 */
692         unsigned int            horkage;        /* List of broken features */
693         unsigned long           flags;          /* ATA_DFLAG_xxx */
694         struct scsi_device      *sdev;          /* attached SCSI device */
695         void                    *private_data;
696 #ifdef CONFIG_ATA_ACPI
697         union acpi_object       *gtf_cache;
698         unsigned int            gtf_filter;
699 #endif
700 #ifdef CONFIG_SATA_ZPODD
701         void                    *zpodd;
702 #endif
703         struct device           tdev;
704         /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
705         u64                     n_sectors;      /* size of device, if ATA */
706         u64                     n_native_sectors; /* native size, if ATA */
707         unsigned int            class;          /* ATA_DEV_xxx */
708         unsigned long           unpark_deadline;
709
710         u8                      pio_mode;
711         u8                      dma_mode;
712         u8                      xfer_mode;
713         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
714
715         unsigned int            multi_count;    /* sectors count for
716                                                    READ/WRITE MULTIPLE */
717         unsigned int            max_sectors;    /* per-device max sectors */
718         unsigned int            cdb_len;
719
720         /* per-dev xfer mask */
721         unsigned long           pio_mask;
722         unsigned long           mwdma_mask;
723         unsigned long           udma_mask;
724
725         /* for CHS addressing */
726         u16                     cylinders;      /* Number of cylinders */
727         u16                     heads;          /* Number of heads */
728         u16                     sectors;        /* Number of sectors per track */
729
730         union {
731                 u16             id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
732                 u32             gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
733         } ____cacheline_aligned;
734
735         /* DEVSLP Timing Variables from Identify Device Data Log */
736         u8                      devslp_timing[ATA_LOG_DEVSLP_SIZE];
737
738         /* NCQ send and receive log subcommand support */
739         u8                      ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
740         u8                      ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
741
742         /* ZAC zone configuration */
743         u32                     zac_zoned_cap;
744         u32                     zac_zones_optimal_open;
745         u32                     zac_zones_optimal_nonseq;
746         u32                     zac_zones_max_open;
747
748         /* error history */
749         int                     spdn_cnt;
750         /* ering is CLEAR_END, read comment above CLEAR_END */
751         struct ata_ering        ering;
752 };
753
754 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
755  * cleared to zero on ata_dev_init().
756  */
757 #define ATA_DEVICE_CLEAR_BEGIN          offsetof(struct ata_device, n_sectors)
758 #define ATA_DEVICE_CLEAR_END            offsetof(struct ata_device, ering)
759
760 struct ata_eh_info {
761         struct ata_device       *dev;           /* offending device */
762         u32                     serror;         /* SError from LLDD */
763         unsigned int            err_mask;       /* port-wide err_mask */
764         unsigned int            action;         /* ATA_EH_* action mask */
765         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
766         unsigned int            flags;          /* ATA_EHI_* flags */
767
768         unsigned int            probe_mask;
769
770         char                    desc[ATA_EH_DESC_LEN];
771         int                     desc_len;
772 };
773
774 struct ata_eh_context {
775         struct ata_eh_info      i;
776         int                     tries[ATA_MAX_DEVICES];
777         int                     cmd_timeout_idx[ATA_MAX_DEVICES]
778                                                [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
779         unsigned int            classes[ATA_MAX_DEVICES];
780         unsigned int            did_probe_mask;
781         unsigned int            unloaded_mask;
782         unsigned int            saved_ncq_enabled;
783         u8                      saved_xfer_mode[ATA_MAX_DEVICES];
784         /* timestamp for the last reset attempt or success */
785         unsigned long           last_reset;
786 };
787
788 struct ata_acpi_drive
789 {
790         u32 pio;
791         u32 dma;
792 } __packed;
793
794 struct ata_acpi_gtm {
795         struct ata_acpi_drive drive[2];
796         u32 flags;
797 } __packed;
798
799 struct ata_link {
800         struct ata_port         *ap;
801         int                     pmp;            /* port multiplier port # */
802
803         struct device           tdev;
804         unsigned int            active_tag;     /* active tag on this link */
805         u32                     sactive;        /* active NCQ commands */
806
807         unsigned int            flags;          /* ATA_LFLAG_xxx */
808
809         u32                     saved_scontrol; /* SControl on probe */
810         unsigned int            hw_sata_spd_limit;
811         unsigned int            sata_spd_limit;
812         unsigned int            sata_spd;       /* current SATA PHY speed */
813         enum ata_lpm_policy     lpm_policy;
814
815         /* record runtime error info, protected by host_set lock */
816         struct ata_eh_info      eh_info;
817         /* EH context */
818         struct ata_eh_context   eh_context;
819
820         struct ata_device       device[ATA_MAX_DEVICES];
821
822         unsigned long           last_lpm_change; /* when last LPM change happened */
823 };
824 #define ATA_LINK_CLEAR_BEGIN            offsetof(struct ata_link, active_tag)
825 #define ATA_LINK_CLEAR_END              offsetof(struct ata_link, device[0])
826
827 struct ata_port {
828         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
829         struct ata_port_operations *ops;
830         spinlock_t              *lock;
831         /* Flags owned by the EH context. Only EH should touch these once the
832            port is active */
833         unsigned long           flags;  /* ATA_FLAG_xxx */
834         /* Flags that change dynamically, protected by ap->lock */
835         unsigned int            pflags; /* ATA_PFLAG_xxx */
836         unsigned int            print_id; /* user visible unique port ID */
837         unsigned int            local_port_no; /* host local port num */
838         unsigned int            port_no; /* 0 based port no. inside the host */
839
840 #ifdef CONFIG_ATA_SFF
841         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
842         u8                      ctl;    /* cache of ATA control register */
843         u8                      last_ctl;       /* Cache last written value */
844         struct ata_link*        sff_pio_task_link; /* link currently used */
845         struct delayed_work     sff_pio_task;
846 #ifdef CONFIG_ATA_BMDMA
847         struct ata_bmdma_prd    *bmdma_prd;     /* BMDMA SG list */
848         dma_addr_t              bmdma_prd_dma;  /* and its DMA mapping */
849 #endif /* CONFIG_ATA_BMDMA */
850 #endif /* CONFIG_ATA_SFF */
851
852         unsigned int            pio_mask;
853         unsigned int            mwdma_mask;
854         unsigned int            udma_mask;
855         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
856
857         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE + 1];
858         unsigned long           sas_tag_allocated; /* for sas tag allocation only */
859         u64                     qc_active;
860         int                     nr_active_links; /* #links with active qcs */
861         unsigned int            sas_last_tag;   /* track next tag hw expects */
862
863         struct ata_link         link;           /* host default link */
864         struct ata_link         *slave_link;    /* see ata_slave_link_init() */
865
866         int                     nr_pmp_links;   /* nr of available PMP links */
867         struct ata_link         *pmp_link;      /* array of PMP links */
868         struct ata_link         *excl_link;     /* for PMP qc exclusion */
869
870         struct ata_port_stats   stats;
871         struct ata_host         *host;
872         struct device           *dev;
873         struct device           tdev;
874
875         struct mutex            scsi_scan_mutex;
876         struct delayed_work     hotplug_task;
877         struct work_struct      scsi_rescan_task;
878
879         unsigned int            hsm_task_state;
880
881         u32                     msg_enable;
882         struct list_head        eh_done_q;
883         wait_queue_head_t       eh_wait_q;
884         int                     eh_tries;
885         struct completion       park_req_pending;
886
887         pm_message_t            pm_mesg;
888         enum ata_lpm_policy     target_lpm_policy;
889
890         struct timer_list       fastdrain_timer;
891         unsigned long           fastdrain_cnt;
892
893         async_cookie_t          cookie;
894
895         int                     em_message_type;
896         void                    *private_data;
897
898 #ifdef CONFIG_ATA_ACPI
899         struct ata_acpi_gtm     __acpi_init_gtm; /* use ata_acpi_init_gtm() */
900 #endif
901         /* owned by EH */
902         u8                      sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
903 };
904
905 /* The following initializer overrides a method to NULL whether one of
906  * its parent has the method defined or not.  This is equivalent to
907  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
908  * expression and thus can't be used as an initializer.
909  */
910 #define ATA_OP_NULL             (void *)(unsigned long)(-ENOENT)
911
912 struct ata_port_operations {
913         /*
914          * Command execution
915          */
916         int (*qc_defer)(struct ata_queued_cmd *qc);
917         int (*check_atapi_dma)(struct ata_queued_cmd *qc);
918         enum ata_completion_errors (*qc_prep)(struct ata_queued_cmd *qc);
919         unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
920         bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
921
922         /*
923          * Configuration and exception handling
924          */
925         int  (*cable_detect)(struct ata_port *ap);
926         unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
927         void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
928         void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
929         int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
930         unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
931
932         void (*dev_config)(struct ata_device *dev);
933
934         void (*freeze)(struct ata_port *ap);
935         void (*thaw)(struct ata_port *ap);
936         ata_prereset_fn_t       prereset;
937         ata_reset_fn_t          softreset;
938         ata_reset_fn_t          hardreset;
939         ata_postreset_fn_t      postreset;
940         ata_prereset_fn_t       pmp_prereset;
941         ata_reset_fn_t          pmp_softreset;
942         ata_reset_fn_t          pmp_hardreset;
943         ata_postreset_fn_t      pmp_postreset;
944         void (*error_handler)(struct ata_port *ap);
945         void (*lost_interrupt)(struct ata_port *ap);
946         void (*post_internal_cmd)(struct ata_queued_cmd *qc);
947         void (*sched_eh)(struct ata_port *ap);
948         void (*end_eh)(struct ata_port *ap);
949
950         /*
951          * Optional features
952          */
953         int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
954         int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
955         void (*pmp_attach)(struct ata_port *ap);
956         void (*pmp_detach)(struct ata_port *ap);
957         int  (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
958                         unsigned hints);
959
960         /*
961          * Start, stop, suspend and resume
962          */
963         int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
964         int  (*port_resume)(struct ata_port *ap);
965         int  (*port_start)(struct ata_port *ap);
966         void (*port_stop)(struct ata_port *ap);
967         void (*host_stop)(struct ata_host *host);
968
969 #ifdef CONFIG_ATA_SFF
970         /*
971          * SFF / taskfile oriented ops
972          */
973         void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
974         void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
975         u8   (*sff_check_status)(struct ata_port *ap);
976         u8   (*sff_check_altstatus)(struct ata_port *ap);
977         void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
978         void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
979         void (*sff_exec_command)(struct ata_port *ap,
980                                  const struct ata_taskfile *tf);
981         unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
982                         unsigned char *buf, unsigned int buflen, int rw);
983         void (*sff_irq_on)(struct ata_port *);
984         bool (*sff_irq_check)(struct ata_port *);
985         void (*sff_irq_clear)(struct ata_port *);
986         void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
987
988 #ifdef CONFIG_ATA_BMDMA
989         void (*bmdma_setup)(struct ata_queued_cmd *qc);
990         void (*bmdma_start)(struct ata_queued_cmd *qc);
991         void (*bmdma_stop)(struct ata_queued_cmd *qc);
992         u8   (*bmdma_status)(struct ata_port *ap);
993 #endif /* CONFIG_ATA_BMDMA */
994 #endif /* CONFIG_ATA_SFF */
995
996         ssize_t (*em_show)(struct ata_port *ap, char *buf);
997         ssize_t (*em_store)(struct ata_port *ap, const char *message,
998                             size_t size);
999         ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
1000         ssize_t (*sw_activity_store)(struct ata_device *dev,
1001                                      enum sw_activity val);
1002         ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
1003                                         ssize_t size);
1004
1005         /*
1006          * Obsolete
1007          */
1008         void (*phy_reset)(struct ata_port *ap);
1009         void (*eng_timeout)(struct ata_port *ap);
1010
1011         /*
1012          * ->inherits must be the last field and all the preceding
1013          * fields must be pointers.
1014          */
1015         const struct ata_port_operations        *inherits;
1016 };
1017
1018 struct ata_port_info {
1019         unsigned long           flags;
1020         unsigned long           link_flags;
1021         unsigned long           pio_mask;
1022         unsigned long           mwdma_mask;
1023         unsigned long           udma_mask;
1024         struct ata_port_operations *port_ops;
1025         void                    *private_data;
1026 };
1027
1028 struct ata_timing {
1029         unsigned short mode;            /* ATA mode */
1030         unsigned short setup;           /* t1 */
1031         unsigned short act8b;           /* t2 for 8-bit I/O */
1032         unsigned short rec8b;           /* t2i for 8-bit I/O */
1033         unsigned short cyc8b;           /* t0 for 8-bit I/O */
1034         unsigned short active;          /* t2 or tD */
1035         unsigned short recover;         /* t2i or tK */
1036         unsigned short dmack_hold;      /* tj */
1037         unsigned short cycle;           /* t0 */
1038         unsigned short udma;            /* t2CYCTYP/2 */
1039 };
1040
1041 /*
1042  * Core layer - drivers/ata/libata-core.c
1043  */
1044 extern const unsigned long sata_deb_timing_normal[];
1045 extern const unsigned long sata_deb_timing_hotplug[];
1046 extern const unsigned long sata_deb_timing_long[];
1047
1048 extern struct ata_port_operations ata_dummy_port_ops;
1049 extern const struct ata_port_info ata_dummy_port_info;
1050
1051 static inline bool ata_is_atapi(u8 prot)
1052 {
1053         return prot & ATA_PROT_FLAG_ATAPI;
1054 }
1055
1056 static inline bool ata_is_pio(u8 prot)
1057 {
1058         return prot & ATA_PROT_FLAG_PIO;
1059 }
1060
1061 static inline bool ata_is_dma(u8 prot)
1062 {
1063         return prot & ATA_PROT_FLAG_DMA;
1064 }
1065
1066 static inline bool ata_is_ncq(u8 prot)
1067 {
1068         return prot & ATA_PROT_FLAG_NCQ;
1069 }
1070
1071 static inline bool ata_is_data(u8 prot)
1072 {
1073         return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1074 }
1075
1076 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1077 {
1078         return (tf->command == ATA_CMD_READ_MULTI) ||
1079                (tf->command == ATA_CMD_WRITE_MULTI) ||
1080                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1081                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1082                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1083 }
1084
1085 static inline const unsigned long *
1086 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1087 {
1088         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1089                 return sata_deb_timing_hotplug;
1090         else
1091                 return sata_deb_timing_normal;
1092 }
1093
1094 static inline int ata_port_is_dummy(struct ata_port *ap)
1095 {
1096         return ap->ops == &ata_dummy_port_ops;
1097 }
1098
1099 extern int sata_set_spd(struct ata_link *link);
1100 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1101 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1102                                 int (*check_ready)(struct ata_link *link));
1103 extern int sata_link_debounce(struct ata_link *link,
1104                         const unsigned long *params, unsigned long deadline);
1105 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1106                             unsigned long deadline);
1107 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1108                              bool spm_wakeup);
1109 extern int sata_link_hardreset(struct ata_link *link,
1110                         const unsigned long *timing, unsigned long deadline,
1111                         bool *online, int (*check_ready)(struct ata_link *));
1112 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1113                               unsigned long deadline);
1114 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1115
1116 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
1117 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1118                         const struct ata_port_info * const * ppi, int n_ports);
1119 extern int ata_slave_link_init(struct ata_port *ap);
1120 extern void ata_host_get(struct ata_host *host);
1121 extern void ata_host_put(struct ata_host *host);
1122 extern int ata_host_start(struct ata_host *host);
1123 extern int ata_host_register(struct ata_host *host,
1124                              struct scsi_host_template *sht);
1125 extern int ata_host_activate(struct ata_host *host, int irq,
1126                              irq_handler_t irq_handler, unsigned long irq_flags,
1127                              struct scsi_host_template *sht);
1128 extern void ata_host_detach(struct ata_host *host);
1129 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1130 extern int ata_scsi_detect(struct scsi_host_template *sht);
1131 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
1132 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1133 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1134                             int cmd, void __user *arg);
1135 extern void ata_sas_port_destroy(struct ata_port *);
1136 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
1137                                            struct ata_port_info *, struct Scsi_Host *);
1138 extern void ata_sas_async_probe(struct ata_port *ap);
1139 extern int ata_sas_sync_probe(struct ata_port *ap);
1140 extern int ata_sas_port_init(struct ata_port *);
1141 extern int ata_sas_port_start(struct ata_port *ap);
1142 extern int ata_sas_tport_add(struct device *parent, struct ata_port *ap);
1143 extern void ata_sas_tport_delete(struct ata_port *ap);
1144 extern void ata_sas_port_stop(struct ata_port *ap);
1145 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
1146 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1147 extern int sata_scr_valid(struct ata_link *link);
1148 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1149 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1150 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1151 extern bool ata_link_online(struct ata_link *link);
1152 extern bool ata_link_offline(struct ata_link *link);
1153 #ifdef CONFIG_PM
1154 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1155 extern void ata_host_resume(struct ata_host *host);
1156 extern void ata_sas_port_suspend(struct ata_port *ap);
1157 extern void ata_sas_port_resume(struct ata_port *ap);
1158 #else
1159 static inline void ata_sas_port_suspend(struct ata_port *ap)
1160 {
1161 }
1162 static inline void ata_sas_port_resume(struct ata_port *ap)
1163 {
1164 }
1165 #endif
1166 extern int ata_ratelimit(void);
1167 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1168 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1169                         u32 val, unsigned long interval, unsigned long timeout);
1170 extern int atapi_cmd_type(u8 opcode);
1171 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1172                           u8 pmp, int is_cmd, u8 *fis);
1173 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1174 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1175                         unsigned long mwdma_mask, unsigned long udma_mask);
1176 extern void ata_unpack_xfermask(unsigned long xfer_mask,
1177                         unsigned long *pio_mask, unsigned long *mwdma_mask,
1178                         unsigned long *udma_mask);
1179 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1180 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1181 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1182 extern const char *ata_mode_string(unsigned long xfer_mask);
1183 extern unsigned long ata_id_xfermask(const u16 *id);
1184 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1185 extern enum ata_completion_errors ata_noop_qc_prep(struct ata_queued_cmd *qc);
1186 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1187                  unsigned int n_elem);
1188 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1189 extern void ata_dev_disable(struct ata_device *adev);
1190 extern void ata_id_string(const u16 *id, unsigned char *s,
1191                           unsigned int ofs, unsigned int len);
1192 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1193                             unsigned int ofs, unsigned int len);
1194 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1195                                         struct ata_taskfile *tf, u16 *id);
1196 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1197 extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1198 extern u64 ata_qc_get_active(struct ata_port *ap);
1199 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1200 extern int ata_std_bios_param(struct scsi_device *sdev,
1201                               struct block_device *bdev,
1202                               sector_t capacity, int geom[]);
1203 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1204 extern int ata_scsi_slave_config(struct scsi_device *sdev);
1205 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1206 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1207                                        int queue_depth);
1208 extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1209                                     int queue_depth);
1210 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1211 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1212 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1213 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1214 extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1215
1216 extern int ata_cable_40wire(struct ata_port *ap);
1217 extern int ata_cable_80wire(struct ata_port *ap);
1218 extern int ata_cable_sata(struct ata_port *ap);
1219 extern int ata_cable_ignore(struct ata_port *ap);
1220 extern int ata_cable_unknown(struct ata_port *ap);
1221
1222 /* Timing helpers */
1223 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1224 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1225 extern int ata_timing_compute(struct ata_device *, unsigned short,
1226                               struct ata_timing *, int, int);
1227 extern void ata_timing_merge(const struct ata_timing *,
1228                              const struct ata_timing *, struct ata_timing *,
1229                              unsigned int);
1230 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1231
1232 /* PCI */
1233 #ifdef CONFIG_PCI
1234 struct pci_dev;
1235
1236 struct pci_bits {
1237         unsigned int            reg;    /* PCI config register to read */
1238         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1239         unsigned long           mask;
1240         unsigned long           val;
1241 };
1242
1243 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1244 extern void ata_pci_shutdown_one(struct pci_dev *pdev);
1245 extern void ata_pci_remove_one(struct pci_dev *pdev);
1246
1247 #ifdef CONFIG_PM
1248 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1249 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1250 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1251 extern int ata_pci_device_resume(struct pci_dev *pdev);
1252 #endif /* CONFIG_PM */
1253 #endif /* CONFIG_PCI */
1254
1255 struct platform_device;
1256
1257 extern int ata_platform_remove_one(struct platform_device *pdev);
1258
1259 /*
1260  * ACPI - drivers/ata/libata-acpi.c
1261  */
1262 #ifdef CONFIG_ATA_ACPI
1263 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1264 {
1265         if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1266                 return &ap->__acpi_init_gtm;
1267         return NULL;
1268 }
1269 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1270 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1271 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1272                                     const struct ata_acpi_gtm *gtm);
1273 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1274 #else
1275 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1276 {
1277         return NULL;
1278 }
1279
1280 static inline int ata_acpi_stm(const struct ata_port *ap,
1281                                struct ata_acpi_gtm *stm)
1282 {
1283         return -ENOSYS;
1284 }
1285
1286 static inline int ata_acpi_gtm(const struct ata_port *ap,
1287                                struct ata_acpi_gtm *stm)
1288 {
1289         return -ENOSYS;
1290 }
1291
1292 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1293                                         const struct ata_acpi_gtm *gtm)
1294 {
1295         return 0;
1296 }
1297
1298 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1299                                       const struct ata_acpi_gtm *gtm)
1300 {
1301         return 0;
1302 }
1303 #endif
1304
1305 /*
1306  * EH - drivers/ata/libata-eh.c
1307  */
1308 extern void ata_port_schedule_eh(struct ata_port *ap);
1309 extern void ata_port_wait_eh(struct ata_port *ap);
1310 extern int ata_link_abort(struct ata_link *link);
1311 extern int ata_port_abort(struct ata_port *ap);
1312 extern int ata_port_freeze(struct ata_port *ap);
1313 extern int sata_async_notification(struct ata_port *ap);
1314
1315 extern void ata_eh_freeze_port(struct ata_port *ap);
1316 extern void ata_eh_thaw_port(struct ata_port *ap);
1317
1318 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1319 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1320 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1321
1322 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1323                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1324                       ata_postreset_fn_t postreset);
1325 extern void ata_std_error_handler(struct ata_port *ap);
1326 extern void ata_std_sched_eh(struct ata_port *ap);
1327 extern void ata_std_end_eh(struct ata_port *ap);
1328 extern int ata_link_nr_enabled(struct ata_link *link);
1329
1330 /*
1331  * Base operations to inherit from and initializers for sht
1332  *
1333  * Operations
1334  *
1335  * base  : Common to all libata drivers.
1336  * sata  : SATA controllers w/ native interface.
1337  * pmp   : SATA controllers w/ PMP support.
1338  * sff   : SFF ATA controllers w/o BMDMA support.
1339  * bmdma : SFF ATA controllers w/ BMDMA support.
1340  *
1341  * sht initializers
1342  *
1343  * BASE  : Common to all libata drivers.  The user must set
1344  *         sg_tablesize and dma_boundary.
1345  * PIO   : SFF ATA controllers w/ only PIO support.
1346  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1347  *         dma_boundary are set to BMDMA limits.
1348  * NCQ   : SATA controllers supporting NCQ.  The user must set
1349  *         sg_tablesize, dma_boundary and can_queue.
1350  */
1351 extern const struct ata_port_operations ata_base_port_ops;
1352 extern const struct ata_port_operations sata_port_ops;
1353 extern struct device_attribute *ata_common_sdev_attrs[];
1354
1355 /*
1356  * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1357  * by the edge drivers.  Because the 'module' field of sht must be the
1358  * edge driver's module reference, otherwise the driver can be unloaded
1359  * even if the scsi_device is being accessed.
1360  */
1361 #define ATA_BASE_SHT(drv_name)                                  \
1362         .module                 = THIS_MODULE,                  \
1363         .name                   = drv_name,                     \
1364         .ioctl                  = ata_scsi_ioctl,               \
1365         .queuecommand           = ata_scsi_queuecmd,            \
1366         .can_queue              = ATA_DEF_QUEUE,                \
1367         .tag_alloc_policy       = BLK_TAG_ALLOC_RR,             \
1368         .this_id                = ATA_SHT_THIS_ID,              \
1369         .emulated               = ATA_SHT_EMULATED,             \
1370         .use_clustering         = ATA_SHT_USE_CLUSTERING,       \
1371         .proc_name              = drv_name,                     \
1372         .slave_configure        = ata_scsi_slave_config,        \
1373         .slave_destroy          = ata_scsi_slave_destroy,       \
1374         .bios_param             = ata_std_bios_param,           \
1375         .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
1376         .sdev_attrs             = ata_common_sdev_attrs
1377
1378 #define ATA_NCQ_SHT(drv_name)                                   \
1379         ATA_BASE_SHT(drv_name),                                 \
1380         .change_queue_depth     = ata_scsi_change_queue_depth
1381
1382 /*
1383  * PMP helpers
1384  */
1385 #ifdef CONFIG_SATA_PMP
1386 static inline bool sata_pmp_supported(struct ata_port *ap)
1387 {
1388         return ap->flags & ATA_FLAG_PMP;
1389 }
1390
1391 static inline bool sata_pmp_attached(struct ata_port *ap)
1392 {
1393         return ap->nr_pmp_links != 0;
1394 }
1395
1396 static inline bool ata_is_host_link(const struct ata_link *link)
1397 {
1398         return link == &link->ap->link || link == link->ap->slave_link;
1399 }
1400 #else /* CONFIG_SATA_PMP */
1401 static inline bool sata_pmp_supported(struct ata_port *ap)
1402 {
1403         return false;
1404 }
1405
1406 static inline bool sata_pmp_attached(struct ata_port *ap)
1407 {
1408         return false;
1409 }
1410
1411 static inline bool ata_is_host_link(const struct ata_link *link)
1412 {
1413         return 1;
1414 }
1415 #endif /* CONFIG_SATA_PMP */
1416
1417 static inline int sata_srst_pmp(struct ata_link *link)
1418 {
1419         if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1420                 return SATA_PMP_CTRL_PORT;
1421         return link->pmp;
1422 }
1423
1424 /*
1425  * printk helpers
1426  */
1427 __printf(3, 4)
1428 void ata_port_printk(const struct ata_port *ap, const char *level,
1429                      const char *fmt, ...);
1430 __printf(3, 4)
1431 void ata_link_printk(const struct ata_link *link, const char *level,
1432                      const char *fmt, ...);
1433 __printf(3, 4)
1434 void ata_dev_printk(const struct ata_device *dev, const char *level,
1435                     const char *fmt, ...);
1436
1437 #define ata_port_err(ap, fmt, ...)                              \
1438         ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1439 #define ata_port_warn(ap, fmt, ...)                             \
1440         ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1441 #define ata_port_notice(ap, fmt, ...)                           \
1442         ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1443 #define ata_port_info(ap, fmt, ...)                             \
1444         ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1445 #define ata_port_dbg(ap, fmt, ...)                              \
1446         ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
1447
1448 #define ata_link_err(link, fmt, ...)                            \
1449         ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1450 #define ata_link_warn(link, fmt, ...)                           \
1451         ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1452 #define ata_link_notice(link, fmt, ...)                         \
1453         ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1454 #define ata_link_info(link, fmt, ...)                           \
1455         ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1456 #define ata_link_dbg(link, fmt, ...)                            \
1457         ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1458
1459 #define ata_dev_err(dev, fmt, ...)                              \
1460         ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1461 #define ata_dev_warn(dev, fmt, ...)                             \
1462         ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1463 #define ata_dev_notice(dev, fmt, ...)                           \
1464         ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1465 #define ata_dev_info(dev, fmt, ...)                             \
1466         ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1467 #define ata_dev_dbg(dev, fmt, ...)                              \
1468         ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
1469
1470 void ata_print_version(const struct device *dev, const char *version);
1471
1472 /*
1473  * ata_eh_info helpers
1474  */
1475 extern __printf(2, 3)
1476 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1477 extern __printf(2, 3)
1478 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1479 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1480
1481 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1482 {
1483         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1484         ehi->flags |= ATA_EHI_HOTPLUGGED;
1485         ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1486         ehi->err_mask |= AC_ERR_ATA_BUS;
1487 }
1488
1489 /*
1490  * port description helpers
1491  */
1492 extern __printf(2, 3)
1493 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1494 #ifdef CONFIG_PCI
1495 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1496                                const char *name);
1497 #endif
1498
1499 static inline bool ata_tag_internal(unsigned int tag)
1500 {
1501         return tag == ATA_TAG_INTERNAL;
1502 }
1503
1504 static inline bool ata_tag_valid(unsigned int tag)
1505 {
1506         return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1507 }
1508
1509 #define __ata_qc_for_each(ap, qc, tag, max_tag, fn)             \
1510         for ((tag) = 0; (tag) < (max_tag) &&                    \
1511              ({ qc = fn((ap), (tag)); 1; }); (tag)++)           \
1512
1513 /*
1514  * Internal use only, iterate commands ignoring error handling and
1515  * status of 'qc'.
1516  */
1517 #define ata_qc_for_each_raw(ap, qc, tag)                                        \
1518         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1519
1520 /*
1521  * Iterate all potential commands that can be queued
1522  */
1523 #define ata_qc_for_each(ap, qc, tag)                                    \
1524         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1525
1526 /*
1527  * Like ata_qc_for_each, but with the internal tag included
1528  */
1529 #define ata_qc_for_each_with_internal(ap, qc, tag)                      \
1530         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1531
1532 /*
1533  * device helpers
1534  */
1535 static inline unsigned int ata_class_enabled(unsigned int class)
1536 {
1537         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1538                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1539                 class == ATA_DEV_ZAC;
1540 }
1541
1542 static inline unsigned int ata_class_disabled(unsigned int class)
1543 {
1544         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1545                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1546                 class == ATA_DEV_ZAC_UNSUP;
1547 }
1548
1549 static inline unsigned int ata_class_absent(unsigned int class)
1550 {
1551         return !ata_class_enabled(class) && !ata_class_disabled(class);
1552 }
1553
1554 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1555 {
1556         return ata_class_enabled(dev->class);
1557 }
1558
1559 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1560 {
1561         return ata_class_disabled(dev->class);
1562 }
1563
1564 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1565 {
1566         return ata_class_absent(dev->class);
1567 }
1568
1569 /*
1570  * link helpers
1571  */
1572 static inline int ata_link_max_devices(const struct ata_link *link)
1573 {
1574         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1575                 return 2;
1576         return 1;
1577 }
1578
1579 static inline int ata_link_active(struct ata_link *link)
1580 {
1581         return ata_tag_valid(link->active_tag) || link->sactive;
1582 }
1583
1584 /*
1585  * Iterators
1586  *
1587  * ATA_LITER_* constants are used to select link iteration mode and
1588  * ATA_DITER_* device iteration mode.
1589  *
1590  * For a custom iteration directly using ata_{link|dev}_next(), if
1591  * @link or @dev, respectively, is NULL, the first element is
1592  * returned.  @dev and @link can be any valid device or link and the
1593  * next element according to the iteration mode will be returned.
1594  * After the last element, NULL is returned.
1595  */
1596 enum ata_link_iter_mode {
1597         ATA_LITER_EDGE,         /* if present, PMP links only; otherwise,
1598                                  * host link.  no slave link */
1599         ATA_LITER_HOST_FIRST,   /* host link followed by PMP or slave links */
1600         ATA_LITER_PMP_FIRST,    /* PMP links followed by host link,
1601                                  * slave link still comes after host link */
1602 };
1603
1604 enum ata_dev_iter_mode {
1605         ATA_DITER_ENABLED,
1606         ATA_DITER_ENABLED_REVERSE,
1607         ATA_DITER_ALL,
1608         ATA_DITER_ALL_REVERSE,
1609 };
1610
1611 extern struct ata_link *ata_link_next(struct ata_link *link,
1612                                       struct ata_port *ap,
1613                                       enum ata_link_iter_mode mode);
1614
1615 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1616                                        struct ata_link *link,
1617                                        enum ata_dev_iter_mode mode);
1618
1619 /*
1620  * Shortcut notation for iterations
1621  *
1622  * ata_for_each_link() iterates over each link of @ap according to
1623  * @mode.  @link points to the current link in the loop.  @link is
1624  * NULL after loop termination.  ata_for_each_dev() works the same way
1625  * except that it iterates over each device of @link.
1626  *
1627  * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1628  * specified when using the following shorthand notations.  Only the
1629  * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1630  * specified.  This not only increases brevity but also makes it
1631  * impossible to use ATA_LITER_* for device iteration or vice-versa.
1632  */
1633 #define ata_for_each_link(link, ap, mode) \
1634         for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1635              (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1636
1637 #define ata_for_each_dev(dev, link, mode) \
1638         for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1639              (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1640
1641 /**
1642  *      ata_ncq_enabled - Test whether NCQ is enabled
1643  *      @dev: ATA device to test for
1644  *
1645  *      LOCKING:
1646  *      spin_lock_irqsave(host lock)
1647  *
1648  *      RETURNS:
1649  *      1 if NCQ is enabled for @dev, 0 otherwise.
1650  */
1651 static inline int ata_ncq_enabled(struct ata_device *dev)
1652 {
1653         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1654                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1655 }
1656
1657 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1658 {
1659         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1660                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1661                  ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1662 }
1663
1664 static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1665 {
1666         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1667                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1668                  ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1669 }
1670
1671 static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1672 {
1673         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1674                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1675                 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1676 }
1677
1678 static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1679 {
1680         return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1681                 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1682 }
1683
1684 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1685 {
1686         qc->tf.ctl |= ATA_NIEN;
1687 }
1688
1689 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1690                                                        unsigned int tag)
1691 {
1692         if (ata_tag_valid(tag))
1693                 return &ap->qcmd[tag];
1694         return NULL;
1695 }
1696
1697 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1698                                                      unsigned int tag)
1699 {
1700         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1701
1702         if (unlikely(!qc) || !ap->ops->error_handler)
1703                 return qc;
1704
1705         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1706                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1707                 return qc;
1708
1709         return NULL;
1710 }
1711
1712 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1713 {
1714         return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1715 }
1716
1717 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1718 {
1719         memset(tf, 0, sizeof(*tf));
1720
1721 #ifdef CONFIG_ATA_SFF
1722         tf->ctl = dev->link->ap->ctl;
1723 #else
1724         tf->ctl = ATA_DEVCTL_OBS;
1725 #endif
1726         if (dev->devno == 0)
1727                 tf->device = ATA_DEVICE_OBS;
1728         else
1729                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1730 }
1731
1732 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1733 {
1734         qc->dma_dir = DMA_NONE;
1735         qc->sg = NULL;
1736         qc->flags = 0;
1737         qc->cursg = NULL;
1738         qc->cursg_ofs = 0;
1739         qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1740         qc->n_elem = 0;
1741         qc->err_mask = 0;
1742         qc->sect_size = ATA_SECT_SIZE;
1743
1744         ata_tf_init(qc->dev, &qc->tf);
1745
1746         /* init result_tf such that it indicates normal completion */
1747         qc->result_tf.command = ATA_DRDY;
1748         qc->result_tf.feature = 0;
1749 }
1750
1751 static inline int ata_try_flush_cache(const struct ata_device *dev)
1752 {
1753         return ata_id_wcache_enabled(dev->id) ||
1754                ata_id_has_flush(dev->id) ||
1755                ata_id_has_flush_ext(dev->id);
1756 }
1757
1758 static inline unsigned int ac_err_mask(u8 status)
1759 {
1760         if (status & (ATA_BUSY | ATA_DRQ))
1761                 return AC_ERR_HSM;
1762         if (status & (ATA_ERR | ATA_DF))
1763                 return AC_ERR_DEV;
1764         return 0;
1765 }
1766
1767 static inline unsigned int __ac_err_mask(u8 status)
1768 {
1769         unsigned int mask = ac_err_mask(status);
1770         if (mask == 0)
1771                 return AC_ERR_OTHER;
1772         return mask;
1773 }
1774
1775 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1776 {
1777         return *(struct ata_port **)&host->hostdata[0];
1778 }
1779
1780 static inline int ata_check_ready(u8 status)
1781 {
1782         if (!(status & ATA_BUSY))
1783                 return 1;
1784
1785         /* 0xff indicates either no device or device not ready */
1786         if (status == 0xff)
1787                 return -ENODEV;
1788
1789         return 0;
1790 }
1791
1792 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1793                                          unsigned long timeout_msecs)
1794 {
1795         return from_jiffies + msecs_to_jiffies(timeout_msecs);
1796 }
1797
1798 /* Don't open code these in drivers as there are traps. Firstly the range may
1799    change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1800    > UDMA_0. Dyma ddreigiau */
1801
1802 static inline int ata_using_mwdma(struct ata_device *adev)
1803 {
1804         if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1805                 return 1;
1806         return 0;
1807 }
1808
1809 static inline int ata_using_udma(struct ata_device *adev)
1810 {
1811         if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1812                 return 1;
1813         return 0;
1814 }
1815
1816 static inline int ata_dma_enabled(struct ata_device *adev)
1817 {
1818         return (adev->dma_mode == 0xFF ? 0 : 1);
1819 }
1820
1821 /**************************************************************************
1822  * PMP - drivers/ata/libata-pmp.c
1823  */
1824 #ifdef CONFIG_SATA_PMP
1825
1826 extern const struct ata_port_operations sata_pmp_port_ops;
1827
1828 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1829 extern void sata_pmp_error_handler(struct ata_port *ap);
1830
1831 #else /* CONFIG_SATA_PMP */
1832
1833 #define sata_pmp_port_ops               sata_port_ops
1834 #define sata_pmp_qc_defer_cmd_switch    ata_std_qc_defer
1835 #define sata_pmp_error_handler          ata_std_error_handler
1836
1837 #endif /* CONFIG_SATA_PMP */
1838
1839
1840 /**************************************************************************
1841  * SFF - drivers/ata/libata-sff.c
1842  */
1843 #ifdef CONFIG_ATA_SFF
1844
1845 extern const struct ata_port_operations ata_sff_port_ops;
1846 extern const struct ata_port_operations ata_bmdma32_port_ops;
1847
1848 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1849 #define ATA_PIO_SHT(drv_name)                                   \
1850         ATA_BASE_SHT(drv_name),                                 \
1851         .sg_tablesize           = LIBATA_MAX_PRD,               \
1852         .dma_boundary           = ATA_DMA_BOUNDARY
1853
1854 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1855 extern u8 ata_sff_check_status(struct ata_port *ap);
1856 extern void ata_sff_pause(struct ata_port *ap);
1857 extern void ata_sff_dma_pause(struct ata_port *ap);
1858 extern int ata_sff_busy_sleep(struct ata_port *ap,
1859                               unsigned long timeout_pat, unsigned long timeout);
1860 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1861 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1862 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1863 extern void ata_sff_exec_command(struct ata_port *ap,
1864                                  const struct ata_taskfile *tf);
1865 extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
1866                         unsigned char *buf, unsigned int buflen, int rw);
1867 extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
1868                         unsigned char *buf, unsigned int buflen, int rw);
1869 extern void ata_sff_irq_on(struct ata_port *ap);
1870 extern void ata_sff_irq_clear(struct ata_port *ap);
1871 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1872                             u8 status, int in_wq);
1873 extern void ata_sff_queue_work(struct work_struct *work);
1874 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1875                 unsigned long delay);
1876 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
1877 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1878 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1879 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1880                                       struct ata_queued_cmd *qc);
1881 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1882 extern void ata_sff_lost_interrupt(struct ata_port *ap);
1883 extern void ata_sff_freeze(struct ata_port *ap);
1884 extern void ata_sff_thaw(struct ata_port *ap);
1885 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1886 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1887                                           u8 *r_err);
1888 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1889                                     unsigned long deadline);
1890 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1891                              unsigned long deadline);
1892 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1893                                unsigned long deadline);
1894 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1895 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1896 extern void ata_sff_error_handler(struct ata_port *ap);
1897 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1898 #ifdef CONFIG_PCI
1899 extern int ata_pci_sff_init_host(struct ata_host *host);
1900 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1901                                     const struct ata_port_info * const * ppi,
1902                                     struct ata_host **r_host);
1903 extern int ata_pci_sff_activate_host(struct ata_host *host,
1904                                      irq_handler_t irq_handler,
1905                                      struct scsi_host_template *sht);
1906 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1907                 const struct ata_port_info * const * ppi,
1908                 struct scsi_host_template *sht, void *host_priv, int hflags);
1909 #endif /* CONFIG_PCI */
1910
1911 #ifdef CONFIG_ATA_BMDMA
1912
1913 extern const struct ata_port_operations ata_bmdma_port_ops;
1914
1915 #define ATA_BMDMA_SHT(drv_name)                                 \
1916         ATA_BASE_SHT(drv_name),                                 \
1917         .sg_tablesize           = LIBATA_MAX_PRD,               \
1918         .dma_boundary           = ATA_DMA_BOUNDARY
1919
1920 extern enum ata_completion_errors ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1921 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1922 extern enum ata_completion_errors ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1923 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1924                                       struct ata_queued_cmd *qc);
1925 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1926 extern void ata_bmdma_error_handler(struct ata_port *ap);
1927 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1928 extern void ata_bmdma_irq_clear(struct ata_port *ap);
1929 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1930 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1931 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1932 extern u8 ata_bmdma_status(struct ata_port *ap);
1933 extern int ata_bmdma_port_start(struct ata_port *ap);
1934 extern int ata_bmdma_port_start32(struct ata_port *ap);
1935
1936 #ifdef CONFIG_PCI
1937 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1938 extern void ata_pci_bmdma_init(struct ata_host *host);
1939 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1940                                       const struct ata_port_info * const * ppi,
1941                                       struct ata_host **r_host);
1942 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1943                                   const struct ata_port_info * const * ppi,
1944                                   struct scsi_host_template *sht,
1945                                   void *host_priv, int hflags);
1946 #endif /* CONFIG_PCI */
1947 #endif /* CONFIG_ATA_BMDMA */
1948
1949 /**
1950  *      ata_sff_busy_wait - Wait for a port status register
1951  *      @ap: Port to wait for.
1952  *      @bits: bits that must be clear
1953  *      @max: number of 10uS waits to perform
1954  *
1955  *      Waits up to max*10 microseconds for the selected bits in the port's
1956  *      status register to be cleared.
1957  *      Returns final value of status register.
1958  *
1959  *      LOCKING:
1960  *      Inherited from caller.
1961  */
1962 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1963                                    unsigned int max)
1964 {
1965         u8 status;
1966
1967         do {
1968                 udelay(10);
1969                 status = ap->ops->sff_check_status(ap);
1970                 max--;
1971         } while (status != 0xff && (status & bits) && (max > 0));
1972
1973         return status;
1974 }
1975
1976 /**
1977  *      ata_wait_idle - Wait for a port to be idle.
1978  *      @ap: Port to wait for.
1979  *
1980  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1981  *      Returns final value of status register.
1982  *
1983  *      LOCKING:
1984  *      Inherited from caller.
1985  */
1986 static inline u8 ata_wait_idle(struct ata_port *ap)
1987 {
1988         u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1989
1990 #ifdef ATA_DEBUG
1991         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1992                 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1993                                 status);
1994 #endif
1995
1996         return status;
1997 }
1998 #endif /* CONFIG_ATA_SFF */
1999
2000 #endif /* __LINUX_LIBATA_H__ */