GNU Linux-libre 4.19.242-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 = 7,
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         ATA_HORKAGE_NO_NCQ_ON_ATI = (1 << 27),  /* Disable NCQ on ATI chipset */
444
445          /* DMA mask for user DMA control: User visible values; DO NOT
446             renumber */
447         ATA_DMA_MASK_ATA        = (1 << 0),     /* DMA on ATA Disk */
448         ATA_DMA_MASK_ATAPI      = (1 << 1),     /* DMA on ATAPI */
449         ATA_DMA_MASK_CFA        = (1 << 2),     /* DMA on CF Card */
450
451         /* ATAPI command types */
452         ATAPI_READ              = 0,            /* READs */
453         ATAPI_WRITE             = 1,            /* WRITEs */
454         ATAPI_READ_CD           = 2,            /* READ CD [MSF] */
455         ATAPI_PASS_THRU         = 3,            /* SAT pass-thru */
456         ATAPI_MISC              = 4,            /* the rest */
457
458         /* Timing constants */
459         ATA_TIMING_SETUP        = (1 << 0),
460         ATA_TIMING_ACT8B        = (1 << 1),
461         ATA_TIMING_REC8B        = (1 << 2),
462         ATA_TIMING_CYC8B        = (1 << 3),
463         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
464                                   ATA_TIMING_CYC8B,
465         ATA_TIMING_ACTIVE       = (1 << 4),
466         ATA_TIMING_RECOVER      = (1 << 5),
467         ATA_TIMING_DMACK_HOLD   = (1 << 6),
468         ATA_TIMING_CYCLE        = (1 << 7),
469         ATA_TIMING_UDMA         = (1 << 8),
470         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
471                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
472                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
473                                   ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
474                                   ATA_TIMING_UDMA,
475
476         /* ACPI constants */
477         ATA_ACPI_FILTER_SETXFER = 1 << 0,
478         ATA_ACPI_FILTER_LOCK    = 1 << 1,
479         ATA_ACPI_FILTER_DIPM    = 1 << 2,
480         ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,  /* FPDMA non-zero offset */
481         ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,      /* FPDMA auto activate */
482
483         ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
484                                   ATA_ACPI_FILTER_LOCK |
485                                   ATA_ACPI_FILTER_DIPM,
486 };
487
488 enum ata_xfer_mask {
489         ATA_MASK_PIO            = ((1LU << ATA_NR_PIO_MODES) - 1)
490                                         << ATA_SHIFT_PIO,
491         ATA_MASK_MWDMA          = ((1LU << ATA_NR_MWDMA_MODES) - 1)
492                                         << ATA_SHIFT_MWDMA,
493         ATA_MASK_UDMA           = ((1LU << ATA_NR_UDMA_MODES) - 1)
494                                         << ATA_SHIFT_UDMA,
495 };
496
497 enum hsm_task_states {
498         HSM_ST_IDLE,            /* no command on going */
499         HSM_ST_FIRST,           /* (waiting the device to)
500                                    write CDB or first data block */
501         HSM_ST,                 /* (waiting the device to) transfer data */
502         HSM_ST_LAST,            /* (waiting the device to) complete command */
503         HSM_ST_ERR,             /* error */
504 };
505
506 enum ata_completion_errors {
507         AC_ERR_OK               = 0,        /* no error */
508         AC_ERR_DEV              = (1 << 0), /* device reported error */
509         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
510         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
511         AC_ERR_MEDIA            = (1 << 3), /* media error */
512         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
513         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
514         AC_ERR_SYSTEM           = (1 << 6), /* system error */
515         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
516         AC_ERR_OTHER            = (1 << 8), /* unknown */
517         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
518         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
519 };
520
521 /*
522  * Link power management policy: If you alter this, you also need to
523  * alter libata-scsi.c (for the ascii descriptions)
524  */
525 enum ata_lpm_policy {
526         ATA_LPM_UNKNOWN,
527         ATA_LPM_MAX_POWER,
528         ATA_LPM_MED_POWER,
529         ATA_LPM_MED_POWER_WITH_DIPM, /* Med power + DIPM as win IRST does */
530         ATA_LPM_MIN_POWER_WITH_PARTIAL, /* Min Power + partial and slumber */
531         ATA_LPM_MIN_POWER, /* Min power + no partial (slumber only) */
532 };
533
534 enum ata_lpm_hints {
535         ATA_LPM_EMPTY           = (1 << 0), /* port empty/probing */
536         ATA_LPM_HIPM            = (1 << 1), /* may use HIPM */
537         ATA_LPM_WAKE_ONLY       = (1 << 2), /* only wake up link */
538 };
539
540 /* forward declarations */
541 struct scsi_device;
542 struct ata_port_operations;
543 struct ata_port;
544 struct ata_link;
545 struct ata_queued_cmd;
546
547 /* typedefs */
548 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
549 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
550 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
551                               unsigned long deadline);
552 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
553
554 extern struct device_attribute dev_attr_link_power_management_policy;
555 extern struct device_attribute dev_attr_unload_heads;
556 extern struct device_attribute dev_attr_ncq_prio_enable;
557 extern struct device_attribute dev_attr_em_message_type;
558 extern struct device_attribute dev_attr_em_message;
559 extern struct device_attribute dev_attr_sw_activity;
560
561 enum sw_activity {
562         OFF,
563         BLINK_ON,
564         BLINK_OFF,
565 };
566
567 struct ata_taskfile {
568         unsigned long           flags;          /* ATA_TFLAG_xxx */
569         u8                      protocol;       /* ATA_PROT_xxx */
570
571         u8                      ctl;            /* control reg */
572
573         u8                      hob_feature;    /* additional data */
574         u8                      hob_nsect;      /* to support LBA48 */
575         u8                      hob_lbal;
576         u8                      hob_lbam;
577         u8                      hob_lbah;
578
579         u8                      feature;
580         u8                      nsect;
581         u8                      lbal;
582         u8                      lbam;
583         u8                      lbah;
584
585         u8                      device;
586
587         u8                      command;        /* IO operation */
588
589         u32                     auxiliary;      /* auxiliary field */
590                                                 /* from SATA 3.1 and */
591                                                 /* ATA-8 ACS-3 */
592 };
593
594 #ifdef CONFIG_ATA_SFF
595 struct ata_ioports {
596         void __iomem            *cmd_addr;
597         void __iomem            *data_addr;
598         void __iomem            *error_addr;
599         void __iomem            *feature_addr;
600         void __iomem            *nsect_addr;
601         void __iomem            *lbal_addr;
602         void __iomem            *lbam_addr;
603         void __iomem            *lbah_addr;
604         void __iomem            *device_addr;
605         void __iomem            *status_addr;
606         void __iomem            *command_addr;
607         void __iomem            *altstatus_addr;
608         void __iomem            *ctl_addr;
609 #ifdef CONFIG_ATA_BMDMA
610         void __iomem            *bmdma_addr;
611 #endif /* CONFIG_ATA_BMDMA */
612         void __iomem            *scr_addr;
613 };
614 #endif /* CONFIG_ATA_SFF */
615
616 struct ata_host {
617         spinlock_t              lock;
618         struct device           *dev;
619         void __iomem * const    *iomap;
620         unsigned int            n_ports;
621         unsigned int            n_tags;                 /* nr of NCQ tags */
622         void                    *private_data;
623         struct ata_port_operations *ops;
624         unsigned long           flags;
625         struct kref             kref;
626
627         struct mutex            eh_mutex;
628         struct task_struct      *eh_owner;
629
630         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
631         struct ata_port         *ports[0];
632 };
633
634 struct ata_queued_cmd {
635         struct ata_port         *ap;
636         struct ata_device       *dev;
637
638         struct scsi_cmnd        *scsicmd;
639         void                    (*scsidone)(struct scsi_cmnd *);
640
641         struct ata_taskfile     tf;
642         u8                      cdb[ATAPI_CDB_LEN];
643
644         unsigned long           flags;          /* ATA_QCFLAG_xxx */
645         unsigned int            tag;            /* libata core tag */
646         unsigned int            hw_tag;         /* driver tag */
647         unsigned int            n_elem;
648         unsigned int            orig_n_elem;
649
650         int                     dma_dir;
651
652         unsigned int            sect_size;
653
654         unsigned int            nbytes;
655         unsigned int            extrabytes;
656         unsigned int            curbytes;
657
658         struct scatterlist      sgent;
659
660         struct scatterlist      *sg;
661
662         struct scatterlist      *cursg;
663         unsigned int            cursg_ofs;
664
665         unsigned int            err_mask;
666         struct ata_taskfile     result_tf;
667         ata_qc_cb_t             complete_fn;
668
669         void                    *private_data;
670         void                    *lldd_task;
671 };
672
673 struct ata_port_stats {
674         unsigned long           unhandled_irq;
675         unsigned long           idle_irq;
676         unsigned long           rw_reqbuf;
677 };
678
679 struct ata_ering_entry {
680         unsigned int            eflags;
681         unsigned int            err_mask;
682         u64                     timestamp;
683 };
684
685 struct ata_ering {
686         int                     cursor;
687         struct ata_ering_entry  ring[ATA_ERING_SIZE];
688 };
689
690 struct ata_device {
691         struct ata_link         *link;
692         unsigned int            devno;          /* 0 or 1 */
693         unsigned int            horkage;        /* List of broken features */
694         unsigned long           flags;          /* ATA_DFLAG_xxx */
695         struct scsi_device      *sdev;          /* attached SCSI device */
696         void                    *private_data;
697 #ifdef CONFIG_ATA_ACPI
698         union acpi_object       *gtf_cache;
699         unsigned int            gtf_filter;
700 #endif
701 #ifdef CONFIG_SATA_ZPODD
702         void                    *zpodd;
703 #endif
704         struct device           tdev;
705         /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
706         u64                     n_sectors;      /* size of device, if ATA */
707         u64                     n_native_sectors; /* native size, if ATA */
708         unsigned int            class;          /* ATA_DEV_xxx */
709         unsigned long           unpark_deadline;
710
711         u8                      pio_mode;
712         u8                      dma_mode;
713         u8                      xfer_mode;
714         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
715
716         unsigned int            multi_count;    /* sectors count for
717                                                    READ/WRITE MULTIPLE */
718         unsigned int            max_sectors;    /* per-device max sectors */
719         unsigned int            cdb_len;
720
721         /* per-dev xfer mask */
722         unsigned long           pio_mask;
723         unsigned long           mwdma_mask;
724         unsigned long           udma_mask;
725
726         /* for CHS addressing */
727         u16                     cylinders;      /* Number of cylinders */
728         u16                     heads;          /* Number of heads */
729         u16                     sectors;        /* Number of sectors per track */
730
731         union {
732                 u16             id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
733                 u32             gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
734         } ____cacheline_aligned;
735
736         /* DEVSLP Timing Variables from Identify Device Data Log */
737         u8                      devslp_timing[ATA_LOG_DEVSLP_SIZE];
738
739         /* NCQ send and receive log subcommand support */
740         u8                      ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
741         u8                      ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_SIZE];
742
743         /* ZAC zone configuration */
744         u32                     zac_zoned_cap;
745         u32                     zac_zones_optimal_open;
746         u32                     zac_zones_optimal_nonseq;
747         u32                     zac_zones_max_open;
748
749         /* error history */
750         int                     spdn_cnt;
751         /* ering is CLEAR_END, read comment above CLEAR_END */
752         struct ata_ering        ering;
753 };
754
755 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
756  * cleared to zero on ata_dev_init().
757  */
758 #define ATA_DEVICE_CLEAR_BEGIN          offsetof(struct ata_device, n_sectors)
759 #define ATA_DEVICE_CLEAR_END            offsetof(struct ata_device, ering)
760
761 struct ata_eh_info {
762         struct ata_device       *dev;           /* offending device */
763         u32                     serror;         /* SError from LLDD */
764         unsigned int            err_mask;       /* port-wide err_mask */
765         unsigned int            action;         /* ATA_EH_* action mask */
766         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
767         unsigned int            flags;          /* ATA_EHI_* flags */
768
769         unsigned int            probe_mask;
770
771         char                    desc[ATA_EH_DESC_LEN];
772         int                     desc_len;
773 };
774
775 struct ata_eh_context {
776         struct ata_eh_info      i;
777         int                     tries[ATA_MAX_DEVICES];
778         int                     cmd_timeout_idx[ATA_MAX_DEVICES]
779                                                [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
780         unsigned int            classes[ATA_MAX_DEVICES];
781         unsigned int            did_probe_mask;
782         unsigned int            unloaded_mask;
783         unsigned int            saved_ncq_enabled;
784         u8                      saved_xfer_mode[ATA_MAX_DEVICES];
785         /* timestamp for the last reset attempt or success */
786         unsigned long           last_reset;
787 };
788
789 struct ata_acpi_drive
790 {
791         u32 pio;
792         u32 dma;
793 } __packed;
794
795 struct ata_acpi_gtm {
796         struct ata_acpi_drive drive[2];
797         u32 flags;
798 } __packed;
799
800 struct ata_link {
801         struct ata_port         *ap;
802         int                     pmp;            /* port multiplier port # */
803
804         struct device           tdev;
805         unsigned int            active_tag;     /* active tag on this link */
806         u32                     sactive;        /* active NCQ commands */
807
808         unsigned int            flags;          /* ATA_LFLAG_xxx */
809
810         u32                     saved_scontrol; /* SControl on probe */
811         unsigned int            hw_sata_spd_limit;
812         unsigned int            sata_spd_limit;
813         unsigned int            sata_spd;       /* current SATA PHY speed */
814         enum ata_lpm_policy     lpm_policy;
815
816         /* record runtime error info, protected by host_set lock */
817         struct ata_eh_info      eh_info;
818         /* EH context */
819         struct ata_eh_context   eh_context;
820
821         struct ata_device       device[ATA_MAX_DEVICES];
822
823         unsigned long           last_lpm_change; /* when last LPM change happened */
824 };
825 #define ATA_LINK_CLEAR_BEGIN            offsetof(struct ata_link, active_tag)
826 #define ATA_LINK_CLEAR_END              offsetof(struct ata_link, device[0])
827
828 struct ata_port {
829         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
830         struct ata_port_operations *ops;
831         spinlock_t              *lock;
832         /* Flags owned by the EH context. Only EH should touch these once the
833            port is active */
834         unsigned long           flags;  /* ATA_FLAG_xxx */
835         /* Flags that change dynamically, protected by ap->lock */
836         unsigned int            pflags; /* ATA_PFLAG_xxx */
837         unsigned int            print_id; /* user visible unique port ID */
838         unsigned int            local_port_no; /* host local port num */
839         unsigned int            port_no; /* 0 based port no. inside the host */
840
841 #ifdef CONFIG_ATA_SFF
842         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
843         u8                      ctl;    /* cache of ATA control register */
844         u8                      last_ctl;       /* Cache last written value */
845         struct ata_link*        sff_pio_task_link; /* link currently used */
846         struct delayed_work     sff_pio_task;
847 #ifdef CONFIG_ATA_BMDMA
848         struct ata_bmdma_prd    *bmdma_prd;     /* BMDMA SG list */
849         dma_addr_t              bmdma_prd_dma;  /* and its DMA mapping */
850 #endif /* CONFIG_ATA_BMDMA */
851 #endif /* CONFIG_ATA_SFF */
852
853         unsigned int            pio_mask;
854         unsigned int            mwdma_mask;
855         unsigned int            udma_mask;
856         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
857
858         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE + 1];
859         unsigned long           sas_tag_allocated; /* for sas tag allocation only */
860         u64                     qc_active;
861         int                     nr_active_links; /* #links with active qcs */
862         unsigned int            sas_last_tag;   /* track next tag hw expects */
863
864         struct ata_link         link;           /* host default link */
865         struct ata_link         *slave_link;    /* see ata_slave_link_init() */
866
867         int                     nr_pmp_links;   /* nr of available PMP links */
868         struct ata_link         *pmp_link;      /* array of PMP links */
869         struct ata_link         *excl_link;     /* for PMP qc exclusion */
870
871         struct ata_port_stats   stats;
872         struct ata_host         *host;
873         struct device           *dev;
874         struct device           tdev;
875
876         struct mutex            scsi_scan_mutex;
877         struct delayed_work     hotplug_task;
878         struct work_struct      scsi_rescan_task;
879
880         unsigned int            hsm_task_state;
881
882         u32                     msg_enable;
883         struct list_head        eh_done_q;
884         wait_queue_head_t       eh_wait_q;
885         int                     eh_tries;
886         struct completion       park_req_pending;
887
888         pm_message_t            pm_mesg;
889         enum ata_lpm_policy     target_lpm_policy;
890
891         struct timer_list       fastdrain_timer;
892         unsigned long           fastdrain_cnt;
893
894         async_cookie_t          cookie;
895
896         int                     em_message_type;
897         void                    *private_data;
898
899 #ifdef CONFIG_ATA_ACPI
900         struct ata_acpi_gtm     __acpi_init_gtm; /* use ata_acpi_init_gtm() */
901 #endif
902         /* owned by EH */
903         u8                      sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
904 };
905
906 /* The following initializer overrides a method to NULL whether one of
907  * its parent has the method defined or not.  This is equivalent to
908  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
909  * expression and thus can't be used as an initializer.
910  */
911 #define ATA_OP_NULL             (void *)(unsigned long)(-ENOENT)
912
913 struct ata_port_operations {
914         /*
915          * Command execution
916          */
917         int (*qc_defer)(struct ata_queued_cmd *qc);
918         int (*check_atapi_dma)(struct ata_queued_cmd *qc);
919         enum ata_completion_errors (*qc_prep)(struct ata_queued_cmd *qc);
920         unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
921         bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
922
923         /*
924          * Configuration and exception handling
925          */
926         int  (*cable_detect)(struct ata_port *ap);
927         unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
928         void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
929         void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
930         int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
931         unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
932
933         void (*dev_config)(struct ata_device *dev);
934
935         void (*freeze)(struct ata_port *ap);
936         void (*thaw)(struct ata_port *ap);
937         ata_prereset_fn_t       prereset;
938         ata_reset_fn_t          softreset;
939         ata_reset_fn_t          hardreset;
940         ata_postreset_fn_t      postreset;
941         ata_prereset_fn_t       pmp_prereset;
942         ata_reset_fn_t          pmp_softreset;
943         ata_reset_fn_t          pmp_hardreset;
944         ata_postreset_fn_t      pmp_postreset;
945         void (*error_handler)(struct ata_port *ap);
946         void (*lost_interrupt)(struct ata_port *ap);
947         void (*post_internal_cmd)(struct ata_queued_cmd *qc);
948         void (*sched_eh)(struct ata_port *ap);
949         void (*end_eh)(struct ata_port *ap);
950
951         /*
952          * Optional features
953          */
954         int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
955         int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
956         void (*pmp_attach)(struct ata_port *ap);
957         void (*pmp_detach)(struct ata_port *ap);
958         int  (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
959                         unsigned hints);
960
961         /*
962          * Start, stop, suspend and resume
963          */
964         int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
965         int  (*port_resume)(struct ata_port *ap);
966         int  (*port_start)(struct ata_port *ap);
967         void (*port_stop)(struct ata_port *ap);
968         void (*host_stop)(struct ata_host *host);
969
970 #ifdef CONFIG_ATA_SFF
971         /*
972          * SFF / taskfile oriented ops
973          */
974         void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
975         void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
976         u8   (*sff_check_status)(struct ata_port *ap);
977         u8   (*sff_check_altstatus)(struct ata_port *ap);
978         void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
979         void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
980         void (*sff_exec_command)(struct ata_port *ap,
981                                  const struct ata_taskfile *tf);
982         unsigned int (*sff_data_xfer)(struct ata_queued_cmd *qc,
983                         unsigned char *buf, unsigned int buflen, int rw);
984         void (*sff_irq_on)(struct ata_port *);
985         bool (*sff_irq_check)(struct ata_port *);
986         void (*sff_irq_clear)(struct ata_port *);
987         void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
988
989 #ifdef CONFIG_ATA_BMDMA
990         void (*bmdma_setup)(struct ata_queued_cmd *qc);
991         void (*bmdma_start)(struct ata_queued_cmd *qc);
992         void (*bmdma_stop)(struct ata_queued_cmd *qc);
993         u8   (*bmdma_status)(struct ata_port *ap);
994 #endif /* CONFIG_ATA_BMDMA */
995 #endif /* CONFIG_ATA_SFF */
996
997         ssize_t (*em_show)(struct ata_port *ap, char *buf);
998         ssize_t (*em_store)(struct ata_port *ap, const char *message,
999                             size_t size);
1000         ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
1001         ssize_t (*sw_activity_store)(struct ata_device *dev,
1002                                      enum sw_activity val);
1003         ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
1004                                         ssize_t size);
1005
1006         /*
1007          * Obsolete
1008          */
1009         void (*phy_reset)(struct ata_port *ap);
1010         void (*eng_timeout)(struct ata_port *ap);
1011
1012         /*
1013          * ->inherits must be the last field and all the preceding
1014          * fields must be pointers.
1015          */
1016         const struct ata_port_operations        *inherits;
1017 };
1018
1019 struct ata_port_info {
1020         unsigned long           flags;
1021         unsigned long           link_flags;
1022         unsigned long           pio_mask;
1023         unsigned long           mwdma_mask;
1024         unsigned long           udma_mask;
1025         struct ata_port_operations *port_ops;
1026         void                    *private_data;
1027 };
1028
1029 struct ata_timing {
1030         unsigned short mode;            /* ATA mode */
1031         unsigned short setup;           /* t1 */
1032         unsigned short act8b;           /* t2 for 8-bit I/O */
1033         unsigned short rec8b;           /* t2i for 8-bit I/O */
1034         unsigned short cyc8b;           /* t0 for 8-bit I/O */
1035         unsigned short active;          /* t2 or tD */
1036         unsigned short recover;         /* t2i or tK */
1037         unsigned short dmack_hold;      /* tj */
1038         unsigned short cycle;           /* t0 */
1039         unsigned short udma;            /* t2CYCTYP/2 */
1040 };
1041
1042 /*
1043  * Core layer - drivers/ata/libata-core.c
1044  */
1045 extern const unsigned long sata_deb_timing_normal[];
1046 extern const unsigned long sata_deb_timing_hotplug[];
1047 extern const unsigned long sata_deb_timing_long[];
1048
1049 extern struct ata_port_operations ata_dummy_port_ops;
1050 extern const struct ata_port_info ata_dummy_port_info;
1051
1052 static inline bool ata_is_atapi(u8 prot)
1053 {
1054         return prot & ATA_PROT_FLAG_ATAPI;
1055 }
1056
1057 static inline bool ata_is_pio(u8 prot)
1058 {
1059         return prot & ATA_PROT_FLAG_PIO;
1060 }
1061
1062 static inline bool ata_is_dma(u8 prot)
1063 {
1064         return prot & ATA_PROT_FLAG_DMA;
1065 }
1066
1067 static inline bool ata_is_ncq(u8 prot)
1068 {
1069         return prot & ATA_PROT_FLAG_NCQ;
1070 }
1071
1072 static inline bool ata_is_data(u8 prot)
1073 {
1074         return prot & (ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA);
1075 }
1076
1077 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1078 {
1079         return (tf->command == ATA_CMD_READ_MULTI) ||
1080                (tf->command == ATA_CMD_WRITE_MULTI) ||
1081                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1082                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1083                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1084 }
1085
1086 static inline const unsigned long *
1087 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1088 {
1089         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1090                 return sata_deb_timing_hotplug;
1091         else
1092                 return sata_deb_timing_normal;
1093 }
1094
1095 static inline int ata_port_is_dummy(struct ata_port *ap)
1096 {
1097         return ap->ops == &ata_dummy_port_ops;
1098 }
1099
1100 extern int sata_set_spd(struct ata_link *link);
1101 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1102 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1103                                 int (*check_ready)(struct ata_link *link));
1104 extern int sata_link_debounce(struct ata_link *link,
1105                         const unsigned long *params, unsigned long deadline);
1106 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1107                             unsigned long deadline);
1108 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1109                              bool spm_wakeup);
1110 extern int sata_link_hardreset(struct ata_link *link,
1111                         const unsigned long *timing, unsigned long deadline,
1112                         bool *online, int (*check_ready)(struct ata_link *));
1113 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1114                               unsigned long deadline);
1115 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1116
1117 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
1118 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1119                         const struct ata_port_info * const * ppi, int n_ports);
1120 extern int ata_slave_link_init(struct ata_port *ap);
1121 extern void ata_host_get(struct ata_host *host);
1122 extern void ata_host_put(struct ata_host *host);
1123 extern int ata_host_start(struct ata_host *host);
1124 extern int ata_host_register(struct ata_host *host,
1125                              struct scsi_host_template *sht);
1126 extern int ata_host_activate(struct ata_host *host, int irq,
1127                              irq_handler_t irq_handler, unsigned long irq_flags,
1128                              struct scsi_host_template *sht);
1129 extern void ata_host_detach(struct ata_host *host);
1130 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1131 extern int ata_scsi_detect(struct scsi_host_template *sht);
1132 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
1133 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1134 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1135                             int cmd, void __user *arg);
1136 extern void ata_sas_port_destroy(struct ata_port *);
1137 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
1138                                            struct ata_port_info *, struct Scsi_Host *);
1139 extern void ata_sas_async_probe(struct ata_port *ap);
1140 extern int ata_sas_sync_probe(struct ata_port *ap);
1141 extern int ata_sas_port_init(struct ata_port *);
1142 extern int ata_sas_port_start(struct ata_port *ap);
1143 extern int ata_sas_tport_add(struct device *parent, struct ata_port *ap);
1144 extern void ata_sas_tport_delete(struct ata_port *ap);
1145 extern void ata_sas_port_stop(struct ata_port *ap);
1146 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
1147 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1148 extern int sata_scr_valid(struct ata_link *link);
1149 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1150 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1151 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1152 extern bool ata_link_online(struct ata_link *link);
1153 extern bool ata_link_offline(struct ata_link *link);
1154 #ifdef CONFIG_PM
1155 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1156 extern void ata_host_resume(struct ata_host *host);
1157 extern void ata_sas_port_suspend(struct ata_port *ap);
1158 extern void ata_sas_port_resume(struct ata_port *ap);
1159 #else
1160 static inline void ata_sas_port_suspend(struct ata_port *ap)
1161 {
1162 }
1163 static inline void ata_sas_port_resume(struct ata_port *ap)
1164 {
1165 }
1166 #endif
1167 extern int ata_ratelimit(void);
1168 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1169 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1170                         u32 val, unsigned long interval, unsigned long timeout);
1171 extern int atapi_cmd_type(u8 opcode);
1172 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1173                           u8 pmp, int is_cmd, u8 *fis);
1174 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1175 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1176                         unsigned long mwdma_mask, unsigned long udma_mask);
1177 extern void ata_unpack_xfermask(unsigned long xfer_mask,
1178                         unsigned long *pio_mask, unsigned long *mwdma_mask,
1179                         unsigned long *udma_mask);
1180 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1181 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1182 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1183 extern const char *ata_mode_string(unsigned long xfer_mask);
1184 extern unsigned long ata_id_xfermask(const u16 *id);
1185 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1186 extern enum ata_completion_errors ata_noop_qc_prep(struct ata_queued_cmd *qc);
1187 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1188                  unsigned int n_elem);
1189 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1190 extern void ata_dev_disable(struct ata_device *adev);
1191 extern void ata_id_string(const u16 *id, unsigned char *s,
1192                           unsigned int ofs, unsigned int len);
1193 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1194                             unsigned int ofs, unsigned int len);
1195 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1196                                         struct ata_taskfile *tf, u16 *id);
1197 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1198 extern int ata_qc_complete_multiple(struct ata_port *ap, u64 qc_active);
1199 extern u64 ata_qc_get_active(struct ata_port *ap);
1200 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1201 extern int ata_std_bios_param(struct scsi_device *sdev,
1202                               struct block_device *bdev,
1203                               sector_t capacity, int geom[]);
1204 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1205 extern int ata_scsi_slave_config(struct scsi_device *sdev);
1206 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1207 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1208                                        int queue_depth);
1209 extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1210                                     int queue_depth);
1211 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1212 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1213 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1214 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1215 extern bool sata_lpm_ignore_phy_events(struct ata_link *link);
1216
1217 extern int ata_cable_40wire(struct ata_port *ap);
1218 extern int ata_cable_80wire(struct ata_port *ap);
1219 extern int ata_cable_sata(struct ata_port *ap);
1220 extern int ata_cable_ignore(struct ata_port *ap);
1221 extern int ata_cable_unknown(struct ata_port *ap);
1222
1223 /* Timing helpers */
1224 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1225 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1226 extern int ata_timing_compute(struct ata_device *, unsigned short,
1227                               struct ata_timing *, int, int);
1228 extern void ata_timing_merge(const struct ata_timing *,
1229                              const struct ata_timing *, struct ata_timing *,
1230                              unsigned int);
1231 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1232
1233 /* PCI */
1234 #ifdef CONFIG_PCI
1235 struct pci_dev;
1236
1237 struct pci_bits {
1238         unsigned int            reg;    /* PCI config register to read */
1239         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1240         unsigned long           mask;
1241         unsigned long           val;
1242 };
1243
1244 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1245 extern void ata_pci_shutdown_one(struct pci_dev *pdev);
1246 extern void ata_pci_remove_one(struct pci_dev *pdev);
1247
1248 #ifdef CONFIG_PM
1249 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1250 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1251 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1252 extern int ata_pci_device_resume(struct pci_dev *pdev);
1253 #endif /* CONFIG_PM */
1254 #endif /* CONFIG_PCI */
1255
1256 struct platform_device;
1257
1258 extern int ata_platform_remove_one(struct platform_device *pdev);
1259
1260 /*
1261  * ACPI - drivers/ata/libata-acpi.c
1262  */
1263 #ifdef CONFIG_ATA_ACPI
1264 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1265 {
1266         if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1267                 return &ap->__acpi_init_gtm;
1268         return NULL;
1269 }
1270 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1271 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1272 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1273                                     const struct ata_acpi_gtm *gtm);
1274 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1275 #else
1276 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1277 {
1278         return NULL;
1279 }
1280
1281 static inline int ata_acpi_stm(const struct ata_port *ap,
1282                                struct ata_acpi_gtm *stm)
1283 {
1284         return -ENOSYS;
1285 }
1286
1287 static inline int ata_acpi_gtm(const struct ata_port *ap,
1288                                struct ata_acpi_gtm *stm)
1289 {
1290         return -ENOSYS;
1291 }
1292
1293 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1294                                         const struct ata_acpi_gtm *gtm)
1295 {
1296         return 0;
1297 }
1298
1299 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1300                                       const struct ata_acpi_gtm *gtm)
1301 {
1302         return 0;
1303 }
1304 #endif
1305
1306 /*
1307  * EH - drivers/ata/libata-eh.c
1308  */
1309 extern void ata_port_schedule_eh(struct ata_port *ap);
1310 extern void ata_port_wait_eh(struct ata_port *ap);
1311 extern int ata_link_abort(struct ata_link *link);
1312 extern int ata_port_abort(struct ata_port *ap);
1313 extern int ata_port_freeze(struct ata_port *ap);
1314 extern int sata_async_notification(struct ata_port *ap);
1315
1316 extern void ata_eh_freeze_port(struct ata_port *ap);
1317 extern void ata_eh_thaw_port(struct ata_port *ap);
1318
1319 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1320 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1321 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1322
1323 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1324                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1325                       ata_postreset_fn_t postreset);
1326 extern void ata_std_error_handler(struct ata_port *ap);
1327 extern void ata_std_sched_eh(struct ata_port *ap);
1328 extern void ata_std_end_eh(struct ata_port *ap);
1329 extern int ata_link_nr_enabled(struct ata_link *link);
1330
1331 /*
1332  * Base operations to inherit from and initializers for sht
1333  *
1334  * Operations
1335  *
1336  * base  : Common to all libata drivers.
1337  * sata  : SATA controllers w/ native interface.
1338  * pmp   : SATA controllers w/ PMP support.
1339  * sff   : SFF ATA controllers w/o BMDMA support.
1340  * bmdma : SFF ATA controllers w/ BMDMA support.
1341  *
1342  * sht initializers
1343  *
1344  * BASE  : Common to all libata drivers.  The user must set
1345  *         sg_tablesize and dma_boundary.
1346  * PIO   : SFF ATA controllers w/ only PIO support.
1347  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1348  *         dma_boundary are set to BMDMA limits.
1349  * NCQ   : SATA controllers supporting NCQ.  The user must set
1350  *         sg_tablesize, dma_boundary and can_queue.
1351  */
1352 extern const struct ata_port_operations ata_base_port_ops;
1353 extern const struct ata_port_operations sata_port_ops;
1354 extern struct device_attribute *ata_common_sdev_attrs[];
1355
1356 /*
1357  * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1358  * by the edge drivers.  Because the 'module' field of sht must be the
1359  * edge driver's module reference, otherwise the driver can be unloaded
1360  * even if the scsi_device is being accessed.
1361  */
1362 #define ATA_BASE_SHT(drv_name)                                  \
1363         .module                 = THIS_MODULE,                  \
1364         .name                   = drv_name,                     \
1365         .ioctl                  = ata_scsi_ioctl,               \
1366         .queuecommand           = ata_scsi_queuecmd,            \
1367         .can_queue              = ATA_DEF_QUEUE,                \
1368         .tag_alloc_policy       = BLK_TAG_ALLOC_RR,             \
1369         .this_id                = ATA_SHT_THIS_ID,              \
1370         .emulated               = ATA_SHT_EMULATED,             \
1371         .use_clustering         = ATA_SHT_USE_CLUSTERING,       \
1372         .proc_name              = drv_name,                     \
1373         .slave_configure        = ata_scsi_slave_config,        \
1374         .slave_destroy          = ata_scsi_slave_destroy,       \
1375         .bios_param             = ata_std_bios_param,           \
1376         .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
1377         .sdev_attrs             = ata_common_sdev_attrs
1378
1379 #define ATA_NCQ_SHT(drv_name)                                   \
1380         ATA_BASE_SHT(drv_name),                                 \
1381         .change_queue_depth     = ata_scsi_change_queue_depth
1382
1383 /*
1384  * PMP helpers
1385  */
1386 #ifdef CONFIG_SATA_PMP
1387 static inline bool sata_pmp_supported(struct ata_port *ap)
1388 {
1389         return ap->flags & ATA_FLAG_PMP;
1390 }
1391
1392 static inline bool sata_pmp_attached(struct ata_port *ap)
1393 {
1394         return ap->nr_pmp_links != 0;
1395 }
1396
1397 static inline bool ata_is_host_link(const struct ata_link *link)
1398 {
1399         return link == &link->ap->link || link == link->ap->slave_link;
1400 }
1401 #else /* CONFIG_SATA_PMP */
1402 static inline bool sata_pmp_supported(struct ata_port *ap)
1403 {
1404         return false;
1405 }
1406
1407 static inline bool sata_pmp_attached(struct ata_port *ap)
1408 {
1409         return false;
1410 }
1411
1412 static inline bool ata_is_host_link(const struct ata_link *link)
1413 {
1414         return 1;
1415 }
1416 #endif /* CONFIG_SATA_PMP */
1417
1418 static inline int sata_srst_pmp(struct ata_link *link)
1419 {
1420         if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1421                 return SATA_PMP_CTRL_PORT;
1422         return link->pmp;
1423 }
1424
1425 /*
1426  * printk helpers
1427  */
1428 __printf(3, 4)
1429 void ata_port_printk(const struct ata_port *ap, const char *level,
1430                      const char *fmt, ...);
1431 __printf(3, 4)
1432 void ata_link_printk(const struct ata_link *link, const char *level,
1433                      const char *fmt, ...);
1434 __printf(3, 4)
1435 void ata_dev_printk(const struct ata_device *dev, const char *level,
1436                     const char *fmt, ...);
1437
1438 #define ata_port_err(ap, fmt, ...)                              \
1439         ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1440 #define ata_port_warn(ap, fmt, ...)                             \
1441         ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1442 #define ata_port_notice(ap, fmt, ...)                           \
1443         ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1444 #define ata_port_info(ap, fmt, ...)                             \
1445         ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1446 #define ata_port_dbg(ap, fmt, ...)                              \
1447         ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
1448
1449 #define ata_link_err(link, fmt, ...)                            \
1450         ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1451 #define ata_link_warn(link, fmt, ...)                           \
1452         ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1453 #define ata_link_notice(link, fmt, ...)                         \
1454         ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1455 #define ata_link_info(link, fmt, ...)                           \
1456         ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1457 #define ata_link_dbg(link, fmt, ...)                            \
1458         ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1459
1460 #define ata_dev_err(dev, fmt, ...)                              \
1461         ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1462 #define ata_dev_warn(dev, fmt, ...)                             \
1463         ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1464 #define ata_dev_notice(dev, fmt, ...)                           \
1465         ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1466 #define ata_dev_info(dev, fmt, ...)                             \
1467         ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1468 #define ata_dev_dbg(dev, fmt, ...)                              \
1469         ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
1470
1471 void ata_print_version(const struct device *dev, const char *version);
1472
1473 /*
1474  * ata_eh_info helpers
1475  */
1476 extern __printf(2, 3)
1477 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1478 extern __printf(2, 3)
1479 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1480 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1481
1482 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1483 {
1484         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1485         ehi->flags |= ATA_EHI_HOTPLUGGED;
1486         ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1487         ehi->err_mask |= AC_ERR_ATA_BUS;
1488 }
1489
1490 /*
1491  * port description helpers
1492  */
1493 extern __printf(2, 3)
1494 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1495 #ifdef CONFIG_PCI
1496 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1497                                const char *name);
1498 #endif
1499
1500 static inline bool ata_tag_internal(unsigned int tag)
1501 {
1502         return tag == ATA_TAG_INTERNAL;
1503 }
1504
1505 static inline bool ata_tag_valid(unsigned int tag)
1506 {
1507         return tag < ATA_MAX_QUEUE || ata_tag_internal(tag);
1508 }
1509
1510 #define __ata_qc_for_each(ap, qc, tag, max_tag, fn)             \
1511         for ((tag) = 0; (tag) < (max_tag) &&                    \
1512              ({ qc = fn((ap), (tag)); 1; }); (tag)++)           \
1513
1514 /*
1515  * Internal use only, iterate commands ignoring error handling and
1516  * status of 'qc'.
1517  */
1518 #define ata_qc_for_each_raw(ap, qc, tag)                                        \
1519         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, __ata_qc_from_tag)
1520
1521 /*
1522  * Iterate all potential commands that can be queued
1523  */
1524 #define ata_qc_for_each(ap, qc, tag)                                    \
1525         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE, ata_qc_from_tag)
1526
1527 /*
1528  * Like ata_qc_for_each, but with the internal tag included
1529  */
1530 #define ata_qc_for_each_with_internal(ap, qc, tag)                      \
1531         __ata_qc_for_each(ap, qc, tag, ATA_MAX_QUEUE + 1, ata_qc_from_tag)
1532
1533 /*
1534  * device helpers
1535  */
1536 static inline unsigned int ata_class_enabled(unsigned int class)
1537 {
1538         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1539                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1540                 class == ATA_DEV_ZAC;
1541 }
1542
1543 static inline unsigned int ata_class_disabled(unsigned int class)
1544 {
1545         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1546                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP ||
1547                 class == ATA_DEV_ZAC_UNSUP;
1548 }
1549
1550 static inline unsigned int ata_class_absent(unsigned int class)
1551 {
1552         return !ata_class_enabled(class) && !ata_class_disabled(class);
1553 }
1554
1555 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1556 {
1557         return ata_class_enabled(dev->class);
1558 }
1559
1560 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1561 {
1562         return ata_class_disabled(dev->class);
1563 }
1564
1565 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1566 {
1567         return ata_class_absent(dev->class);
1568 }
1569
1570 /*
1571  * link helpers
1572  */
1573 static inline int ata_link_max_devices(const struct ata_link *link)
1574 {
1575         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1576                 return 2;
1577         return 1;
1578 }
1579
1580 static inline int ata_link_active(struct ata_link *link)
1581 {
1582         return ata_tag_valid(link->active_tag) || link->sactive;
1583 }
1584
1585 /*
1586  * Iterators
1587  *
1588  * ATA_LITER_* constants are used to select link iteration mode and
1589  * ATA_DITER_* device iteration mode.
1590  *
1591  * For a custom iteration directly using ata_{link|dev}_next(), if
1592  * @link or @dev, respectively, is NULL, the first element is
1593  * returned.  @dev and @link can be any valid device or link and the
1594  * next element according to the iteration mode will be returned.
1595  * After the last element, NULL is returned.
1596  */
1597 enum ata_link_iter_mode {
1598         ATA_LITER_EDGE,         /* if present, PMP links only; otherwise,
1599                                  * host link.  no slave link */
1600         ATA_LITER_HOST_FIRST,   /* host link followed by PMP or slave links */
1601         ATA_LITER_PMP_FIRST,    /* PMP links followed by host link,
1602                                  * slave link still comes after host link */
1603 };
1604
1605 enum ata_dev_iter_mode {
1606         ATA_DITER_ENABLED,
1607         ATA_DITER_ENABLED_REVERSE,
1608         ATA_DITER_ALL,
1609         ATA_DITER_ALL_REVERSE,
1610 };
1611
1612 extern struct ata_link *ata_link_next(struct ata_link *link,
1613                                       struct ata_port *ap,
1614                                       enum ata_link_iter_mode mode);
1615
1616 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1617                                        struct ata_link *link,
1618                                        enum ata_dev_iter_mode mode);
1619
1620 /*
1621  * Shortcut notation for iterations
1622  *
1623  * ata_for_each_link() iterates over each link of @ap according to
1624  * @mode.  @link points to the current link in the loop.  @link is
1625  * NULL after loop termination.  ata_for_each_dev() works the same way
1626  * except that it iterates over each device of @link.
1627  *
1628  * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1629  * specified when using the following shorthand notations.  Only the
1630  * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1631  * specified.  This not only increases brevity but also makes it
1632  * impossible to use ATA_LITER_* for device iteration or vice-versa.
1633  */
1634 #define ata_for_each_link(link, ap, mode) \
1635         for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1636              (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1637
1638 #define ata_for_each_dev(dev, link, mode) \
1639         for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1640              (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1641
1642 /**
1643  *      ata_ncq_enabled - Test whether NCQ is enabled
1644  *      @dev: ATA device to test for
1645  *
1646  *      LOCKING:
1647  *      spin_lock_irqsave(host lock)
1648  *
1649  *      RETURNS:
1650  *      1 if NCQ is enabled for @dev, 0 otherwise.
1651  */
1652 static inline int ata_ncq_enabled(struct ata_device *dev)
1653 {
1654         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1655                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1656 }
1657
1658 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1659 {
1660         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1661                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1662                  ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1663 }
1664
1665 static inline bool ata_fpdma_read_log_supported(struct ata_device *dev)
1666 {
1667         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1668                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET] &
1669                  ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED);
1670 }
1671
1672 static inline bool ata_fpdma_zac_mgmt_in_supported(struct ata_device *dev)
1673 {
1674         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1675                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET] &
1676                 ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED);
1677 }
1678
1679 static inline bool ata_fpdma_zac_mgmt_out_supported(struct ata_device *dev)
1680 {
1681         return (dev->ncq_non_data_cmds[ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET] &
1682                 ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT);
1683 }
1684
1685 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1686 {
1687         qc->tf.ctl |= ATA_NIEN;
1688 }
1689
1690 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1691                                                        unsigned int tag)
1692 {
1693         if (ata_tag_valid(tag))
1694                 return &ap->qcmd[tag];
1695         return NULL;
1696 }
1697
1698 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1699                                                      unsigned int tag)
1700 {
1701         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1702
1703         if (unlikely(!qc) || !ap->ops->error_handler)
1704                 return qc;
1705
1706         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1707                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1708                 return qc;
1709
1710         return NULL;
1711 }
1712
1713 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1714 {
1715         return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1716 }
1717
1718 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1719 {
1720         memset(tf, 0, sizeof(*tf));
1721
1722 #ifdef CONFIG_ATA_SFF
1723         tf->ctl = dev->link->ap->ctl;
1724 #else
1725         tf->ctl = ATA_DEVCTL_OBS;
1726 #endif
1727         if (dev->devno == 0)
1728                 tf->device = ATA_DEVICE_OBS;
1729         else
1730                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1731 }
1732
1733 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1734 {
1735         qc->dma_dir = DMA_NONE;
1736         qc->sg = NULL;
1737         qc->flags = 0;
1738         qc->cursg = NULL;
1739         qc->cursg_ofs = 0;
1740         qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1741         qc->n_elem = 0;
1742         qc->err_mask = 0;
1743         qc->sect_size = ATA_SECT_SIZE;
1744
1745         ata_tf_init(qc->dev, &qc->tf);
1746
1747         /* init result_tf such that it indicates normal completion */
1748         qc->result_tf.command = ATA_DRDY;
1749         qc->result_tf.feature = 0;
1750 }
1751
1752 static inline int ata_try_flush_cache(const struct ata_device *dev)
1753 {
1754         return ata_id_wcache_enabled(dev->id) ||
1755                ata_id_has_flush(dev->id) ||
1756                ata_id_has_flush_ext(dev->id);
1757 }
1758
1759 static inline unsigned int ac_err_mask(u8 status)
1760 {
1761         if (status & (ATA_BUSY | ATA_DRQ))
1762                 return AC_ERR_HSM;
1763         if (status & (ATA_ERR | ATA_DF))
1764                 return AC_ERR_DEV;
1765         return 0;
1766 }
1767
1768 static inline unsigned int __ac_err_mask(u8 status)
1769 {
1770         unsigned int mask = ac_err_mask(status);
1771         if (mask == 0)
1772                 return AC_ERR_OTHER;
1773         return mask;
1774 }
1775
1776 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1777 {
1778         return *(struct ata_port **)&host->hostdata[0];
1779 }
1780
1781 static inline int ata_check_ready(u8 status)
1782 {
1783         if (!(status & ATA_BUSY))
1784                 return 1;
1785
1786         /* 0xff indicates either no device or device not ready */
1787         if (status == 0xff)
1788                 return -ENODEV;
1789
1790         return 0;
1791 }
1792
1793 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1794                                          unsigned long timeout_msecs)
1795 {
1796         return from_jiffies + msecs_to_jiffies(timeout_msecs);
1797 }
1798
1799 /* Don't open code these in drivers as there are traps. Firstly the range may
1800    change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1801    > UDMA_0. Dyma ddreigiau */
1802
1803 static inline int ata_using_mwdma(struct ata_device *adev)
1804 {
1805         if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1806                 return 1;
1807         return 0;
1808 }
1809
1810 static inline int ata_using_udma(struct ata_device *adev)
1811 {
1812         if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1813                 return 1;
1814         return 0;
1815 }
1816
1817 static inline int ata_dma_enabled(struct ata_device *adev)
1818 {
1819         return (adev->dma_mode == 0xFF ? 0 : 1);
1820 }
1821
1822 /**************************************************************************
1823  * PMP - drivers/ata/libata-pmp.c
1824  */
1825 #ifdef CONFIG_SATA_PMP
1826
1827 extern const struct ata_port_operations sata_pmp_port_ops;
1828
1829 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1830 extern void sata_pmp_error_handler(struct ata_port *ap);
1831
1832 #else /* CONFIG_SATA_PMP */
1833
1834 #define sata_pmp_port_ops               sata_port_ops
1835 #define sata_pmp_qc_defer_cmd_switch    ata_std_qc_defer
1836 #define sata_pmp_error_handler          ata_std_error_handler
1837
1838 #endif /* CONFIG_SATA_PMP */
1839
1840
1841 /**************************************************************************
1842  * SFF - drivers/ata/libata-sff.c
1843  */
1844 #ifdef CONFIG_ATA_SFF
1845
1846 extern const struct ata_port_operations ata_sff_port_ops;
1847 extern const struct ata_port_operations ata_bmdma32_port_ops;
1848
1849 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1850 #define ATA_PIO_SHT(drv_name)                                   \
1851         ATA_BASE_SHT(drv_name),                                 \
1852         .sg_tablesize           = LIBATA_MAX_PRD,               \
1853         .dma_boundary           = ATA_DMA_BOUNDARY
1854
1855 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1856 extern u8 ata_sff_check_status(struct ata_port *ap);
1857 extern void ata_sff_pause(struct ata_port *ap);
1858 extern void ata_sff_dma_pause(struct ata_port *ap);
1859 extern int ata_sff_busy_sleep(struct ata_port *ap,
1860                               unsigned long timeout_pat, unsigned long timeout);
1861 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1862 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1863 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1864 extern void ata_sff_exec_command(struct ata_port *ap,
1865                                  const struct ata_taskfile *tf);
1866 extern unsigned int ata_sff_data_xfer(struct ata_queued_cmd *qc,
1867                         unsigned char *buf, unsigned int buflen, int rw);
1868 extern unsigned int ata_sff_data_xfer32(struct ata_queued_cmd *qc,
1869                         unsigned char *buf, unsigned int buflen, int rw);
1870 extern void ata_sff_irq_on(struct ata_port *ap);
1871 extern void ata_sff_irq_clear(struct ata_port *ap);
1872 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1873                             u8 status, int in_wq);
1874 extern void ata_sff_queue_work(struct work_struct *work);
1875 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1876                 unsigned long delay);
1877 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
1878 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1879 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1880 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1881                                       struct ata_queued_cmd *qc);
1882 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1883 extern void ata_sff_lost_interrupt(struct ata_port *ap);
1884 extern void ata_sff_freeze(struct ata_port *ap);
1885 extern void ata_sff_thaw(struct ata_port *ap);
1886 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1887 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1888                                           u8 *r_err);
1889 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1890                                     unsigned long deadline);
1891 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1892                              unsigned long deadline);
1893 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1894                                unsigned long deadline);
1895 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1896 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1897 extern void ata_sff_error_handler(struct ata_port *ap);
1898 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1899 #ifdef CONFIG_PCI
1900 extern int ata_pci_sff_init_host(struct ata_host *host);
1901 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1902                                     const struct ata_port_info * const * ppi,
1903                                     struct ata_host **r_host);
1904 extern int ata_pci_sff_activate_host(struct ata_host *host,
1905                                      irq_handler_t irq_handler,
1906                                      struct scsi_host_template *sht);
1907 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1908                 const struct ata_port_info * const * ppi,
1909                 struct scsi_host_template *sht, void *host_priv, int hflags);
1910 #endif /* CONFIG_PCI */
1911
1912 #ifdef CONFIG_ATA_BMDMA
1913
1914 extern const struct ata_port_operations ata_bmdma_port_ops;
1915
1916 #define ATA_BMDMA_SHT(drv_name)                                 \
1917         ATA_BASE_SHT(drv_name),                                 \
1918         .sg_tablesize           = LIBATA_MAX_PRD,               \
1919         .dma_boundary           = ATA_DMA_BOUNDARY
1920
1921 extern enum ata_completion_errors ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1922 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1923 extern enum ata_completion_errors ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1924 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1925                                       struct ata_queued_cmd *qc);
1926 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1927 extern void ata_bmdma_error_handler(struct ata_port *ap);
1928 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1929 extern void ata_bmdma_irq_clear(struct ata_port *ap);
1930 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1931 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1932 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1933 extern u8 ata_bmdma_status(struct ata_port *ap);
1934 extern int ata_bmdma_port_start(struct ata_port *ap);
1935 extern int ata_bmdma_port_start32(struct ata_port *ap);
1936
1937 #ifdef CONFIG_PCI
1938 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1939 extern void ata_pci_bmdma_init(struct ata_host *host);
1940 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1941                                       const struct ata_port_info * const * ppi,
1942                                       struct ata_host **r_host);
1943 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1944                                   const struct ata_port_info * const * ppi,
1945                                   struct scsi_host_template *sht,
1946                                   void *host_priv, int hflags);
1947 #endif /* CONFIG_PCI */
1948 #endif /* CONFIG_ATA_BMDMA */
1949
1950 /**
1951  *      ata_sff_busy_wait - Wait for a port status register
1952  *      @ap: Port to wait for.
1953  *      @bits: bits that must be clear
1954  *      @max: number of 10uS waits to perform
1955  *
1956  *      Waits up to max*10 microseconds for the selected bits in the port's
1957  *      status register to be cleared.
1958  *      Returns final value of status register.
1959  *
1960  *      LOCKING:
1961  *      Inherited from caller.
1962  */
1963 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1964                                    unsigned int max)
1965 {
1966         u8 status;
1967
1968         do {
1969                 udelay(10);
1970                 status = ap->ops->sff_check_status(ap);
1971                 max--;
1972         } while (status != 0xff && (status & bits) && (max > 0));
1973
1974         return status;
1975 }
1976
1977 /**
1978  *      ata_wait_idle - Wait for a port to be idle.
1979  *      @ap: Port to wait for.
1980  *
1981  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1982  *      Returns final value of status register.
1983  *
1984  *      LOCKING:
1985  *      Inherited from caller.
1986  */
1987 static inline u8 ata_wait_idle(struct ata_port *ap)
1988 {
1989         u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1990
1991 #ifdef ATA_DEBUG
1992         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1993                 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1994                                 status);
1995 #endif
1996
1997         return status;
1998 }
1999 #endif /* CONFIG_ATA_SFF */
2000
2001 #endif /* __LINUX_LIBATA_H__ */