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