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