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