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