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