]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/libata.h
projects / mirror_ubuntu-artful-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ahci: display all AHCI 1.3 HBA capability flags (v2)
[mirror_ubuntu-artful-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 */
368 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 5,
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,
1da177e4
LT		 421};
422
7dc951ae
TH		 423enum ata_xfer_mask {
424 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
425 << ATA_SHIFT_PIO,
426 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
427 << ATA_SHIFT_MWDMA,
428 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
429 << ATA_SHIFT_UDMA,
430};
431
14be71f4 432enum hsm_task_states {
c56b14d2 433 HSM_ST_IDLE, /* no command on going */
71527647
AL		 434 HSM_ST_FIRST, /* (waiting the device to)
435 write CDB or first data block */
c56b14d2
AL		 436 HSM_ST, /* (waiting the device to) transfer data */
437 HSM_ST_LAST, /* (waiting the device to) complete command */
c56b14d2 438 HSM_ST_ERR, /* error */
1da177e4
LT		 439};
440
a7dac447 441enum ata_completion_errors {
11a56d24
TH		 442 AC_ERR_DEV = (1 << 0), /* device reported error */
443 AC_ERR_HSM = (1 << 1), /* host state machine violation */
444 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
445 AC_ERR_MEDIA = (1 << 3), /* media error */
446 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
447 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
448 AC_ERR_SYSTEM = (1 << 6), /* system error */
449 AC_ERR_INVALID = (1 << 7), /* invalid argument */
450 AC_ERR_OTHER = (1 << 8), /* unknown */
55a8e2c8 451 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
5335b729 452 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
a7dac447
JG		 453};
454
1da177e4
LT		 455/* forward declarations */
456struct scsi_device;
457struct ata_port_operations;
458struct ata_port;
cc0680a5 459struct ata_link;
1da177e4
LT		 460struct ata_queued_cmd;
461
462/* typedefs */
77853bf2 463typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
cc0680a5
TH		 464typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
465typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
d4b2bab4 466 unsigned long deadline);
cc0680a5 467typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
1da177e4 468
ca77329f
KCA		 469/*
470 * host pm policy: If you alter this, you also need to alter libata-scsi.c
471 * (for the ascii descriptions)
472 */
473enum link_pm {
474 NOT_AVAILABLE,
475 MIN_POWER,
476 MAX_PERFORMANCE,
477 MEDIUM_POWER,
478};
ee959b00 479extern struct device_attribute dev_attr_link_power_management_policy;
45fabbb7 480extern struct device_attribute dev_attr_unload_heads;
18f7ba4c
KCA		 481extern struct device_attribute dev_attr_em_message_type;
482extern struct device_attribute dev_attr_em_message;
483extern struct device_attribute dev_attr_sw_activity;
484
485enum sw_activity {
486 OFF,
487 BLINK_ON,
488 BLINK_OFF,
489};
ca77329f 490
127102ae 491#ifdef CONFIG_ATA_SFF
1da177e4 492struct ata_ioports {
0d5ff566
TH		 493 void __iomem *cmd_addr;
494 void __iomem *data_addr;
495 void __iomem *error_addr;
496 void __iomem *feature_addr;
497 void __iomem *nsect_addr;
498 void __iomem *lbal_addr;
499 void __iomem *lbam_addr;
500 void __iomem *lbah_addr;
501 void __iomem *device_addr;
502 void __iomem *status_addr;
503 void __iomem *command_addr;
504 void __iomem *altstatus_addr;
505 void __iomem *ctl_addr;
506 void __iomem *bmdma_addr;
507 void __iomem *scr_addr;
1da177e4 508};
127102ae 509#endif /* CONFIG_ATA_SFF */
1da177e4 510
cca3974e 511struct ata_host {
1da177e4
LT		 512 spinlock_t lock;
513 struct device *dev;
0d5ff566 514 void __iomem * const *iomap;
1da177e4
LT		 515 unsigned int n_ports;
516 void *private_data;
029cfd6b 517 struct ata_port_operations *ops;
5444a6f4 518 unsigned long flags;
fafbae87
TH		 519#ifdef CONFIG_ATA_ACPI
520 acpi_handle acpi_handle;
521#endif
032af1ce 522 struct ata_port *simplex_claimed; /* channel owning the DMA */
f0eb62b8 523 struct ata_port *ports[0];
1da177e4
LT		 524};
525
526struct ata_queued_cmd {
527 struct ata_port *ap;
528 struct ata_device *dev;
529
530 struct scsi_cmnd *scsicmd;
531 void (*scsidone)(struct scsi_cmnd *);
532
533 struct ata_taskfile tf;
534 u8 cdb[ATAPI_CDB_LEN];
535
536 unsigned long flags; /* ATA_QCFLAG_xxx */
537 unsigned int tag;
538 unsigned int n_elem;
5825627c 539 unsigned int orig_n_elem;
1da177e4
LT		 540
541 int dma_dir;
542
5a5dbd18 543 unsigned int sect_size;
cedc9a47 544
1da177e4 545 unsigned int nbytes;
aacda375 546 unsigned int extrabytes;
1da177e4
LT		 547 unsigned int curbytes;
548
87260216 549 struct scatterlist *cursg;
1da177e4
LT		 550 unsigned int cursg_ofs;
551
552 struct scatterlist sgent;
1da177e4 553
ff2aeb1e 554 struct scatterlist *sg;
1da177e4 555
a22e2eb0 556 unsigned int err_mask;
e61e0672 557 struct ata_taskfile result_tf;
1da177e4
LT		 558 ata_qc_cb_t complete_fn;
559
1da177e4 560 void *private_data;
1c50dc83 561 void *lldd_task;
1da177e4
LT		 562};
563
cca3974e 564struct ata_port_stats {
1da177e4
LT		 565 unsigned long unhandled_irq;
566 unsigned long idle_irq;
567 unsigned long rw_reqbuf;
568};
569
0c247c55 570struct ata_ering_entry {
3884f7b0 571 unsigned int eflags;
0c247c55
TH		 572 unsigned int err_mask;
573 u64 timestamp;
574};
575
576struct ata_ering {
577 int cursor;
578 struct ata_ering_entry ring[ATA_ERING_SIZE];
579};
580
1da177e4 581struct ata_device {
9af5c9c9 582 struct ata_link *link;
72fa4b74 583 unsigned int devno; /* 0 or 1 */
75683fe7 584 unsigned int horkage; /* List of broken features */
6866e7bc 585 unsigned long flags; /* ATA_DFLAG_xxx */
3edebac4 586 struct scsi_device *sdev; /* attached SCSI device */
fafbae87
TH		 587#ifdef CONFIG_ATA_ACPI
588 acpi_handle acpi_handle;
398e0782 589 union acpi_object *gtf_cache;
fafbae87 590#endif
99cf610a 591 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
72fa4b74 592 u64 n_sectors; /* size of device, if ATA */
5920dadf 593 u64 n_native_sectors; /* native size, if ATA */
1da177e4 594 unsigned int class; /* ATA_DEV_xxx */
45fabbb7 595 unsigned long unpark_deadline;
e0a71752 596
1da177e4
LT		 597 u8 pio_mode;
598 u8 dma_mode;
599 u8 xfer_mode;
600 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
601
8cbd6df1
AL		 602 unsigned int multi_count; /* sectors count for
603 READ/WRITE MULTIPLE */
b00eec1d 604 unsigned int max_sectors; /* per-device max sectors */
6e7846e9 605 unsigned int cdb_len;
8bf62ece 606
acf356b1 607 /* per-dev xfer mask */
7dc951ae
TH		 608 unsigned long pio_mask;
609 unsigned long mwdma_mask;
610 unsigned long udma_mask;
acf356b1 611
8bf62ece
AL		 612 /* for CHS addressing */
613 u16 cylinders; /* Number of cylinders */
614 u16 heads; /* Number of heads */
615 u16 sectors; /* Number of sectors per track */
0c247c55 616
f7e98930
JG		 617 union {
618 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
619 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
620 };
99cf610a
TH		 621
622 /* error history */
623 int spdn_cnt;
624 /* ering is CLEAR_END, read comment above CLEAR_END */
625 struct ata_ering ering;
1da177e4
LT		 626};
627
99cf610a
TH		 628/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
629 * cleared to zero on ata_dev_init().
72fa4b74 630 */
99cf610a
TH		 631#define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
632#define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
72fa4b74 633
f3e81b19
TH		 634struct ata_eh_info {
635 struct ata_device *dev; /* offending device */
636 u32 serror; /* SError from LLDD */
637 unsigned int err_mask; /* port-wide err_mask */
638 unsigned int action; /* ATA_EH_* action mask */
47005f25 639 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
f3e81b19 640 unsigned int flags; /* ATA_EHI_* flags */
abdda733 641
abdda733
TH		 642 unsigned int probe_mask;
643
f3e81b19
TH		 644 char desc[ATA_EH_DESC_LEN];
645 int desc_len;
646};
647
648struct ata_eh_context {
649 struct ata_eh_info i;
650 int tries[ATA_MAX_DEVICES];
87fbc5a0
TH		 651 int cmd_timeout_idx[ATA_MAX_DEVICES]
652 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
abdda733
TH		 653 unsigned int classes[ATA_MAX_DEVICES];
654 unsigned int did_probe_mask;
45fabbb7 655 unsigned int unloaded_mask;
00115e0f
TH		 656 unsigned int saved_ncq_enabled;
657 u8 saved_xfer_mode[ATA_MAX_DEVICES];
0a2c0f56
TH		 658 /* timestamp for the last reset attempt or success */
659 unsigned long last_reset;
f3e81b19
TH		 660};
661
64578a3d
TH		 662struct ata_acpi_drive
663{
664 u32 pio;
665 u32 dma;
666} __packed;
667
668struct ata_acpi_gtm {
669 struct ata_acpi_drive drive[2];
670 u32 flags;
671} __packed;
672
9af5c9c9
TH		 673struct ata_link {
674 struct ata_port *ap;
8989805d 675 int pmp; /* port multiplier port # */
9af5c9c9
TH		 676
677 unsigned int active_tag; /* active tag on this link */
678 u32 sactive; /* active NCQ commands */
679
0c88758b
TH		 680 unsigned int flags; /* ATA_LFLAG_xxx */
681
d127ea7b 682 u32 saved_scontrol; /* SControl on probe */
9af5c9c9
TH		 683 unsigned int hw_sata_spd_limit;
684 unsigned int sata_spd_limit;
685 unsigned int sata_spd; /* current SATA PHY speed */
686
687 /* record runtime error info, protected by host_set lock */
688 struct ata_eh_info eh_info;
689 /* EH context */
690 struct ata_eh_context eh_context;
691
692 struct ata_device device[ATA_MAX_DEVICES];
693};
694
1da177e4 695struct ata_port {
cca3974e 696 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
029cfd6b 697 struct ata_port_operations *ops;
ba6a1308 698 spinlock_t *lock;
e3cf95dd
AC		 699 /* Flags owned by the EH context. Only EH should touch these once the
700 port is active */
1da177e4 701 unsigned long flags; /* ATA_FLAG_xxx */
e3cf95dd 702 /* Flags that change dynamically, protected by ap->lock */
b51e9e5d 703 unsigned int pflags; /* ATA_PFLAG_xxx */
44877b4e
TH		 704 unsigned int print_id; /* user visible unique port ID */
705 unsigned int port_no; /* 0 based port no. inside the host */
1da177e4
LT		 706
707 struct ata_prd *prd; /* our SG list */
708 dma_addr_t prd_dma; /* and its DMA mapping */
709
127102ae 710#ifdef CONFIG_ATA_SFF
1da177e4 711 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
127102ae 712#endif /* CONFIG_ATA_SFF */
1da177e4
LT		 713
714 u8 ctl; /* cache of ATA control register */
715 u8 last_ctl; /* Cache last written value */
1da177e4
LT		 716 unsigned int pio_mask;
717 unsigned int mwdma_mask;
718 unsigned int udma_mask;
719 unsigned int cbl; /* cable type; ATA_CBL_xxx */
1da177e4
LT		 720
721 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
8a8bc223 722 unsigned long qc_allocated;
dedaf2b0 723 unsigned int qc_active;
da917d69 724 int nr_active_links; /* #links with active qcs */
dedaf2b0 725
b1c72916
TH		 726 struct ata_link link; /* host default link */
727 struct ata_link *slave_link; /* see ata_slave_link_init() */
1da177e4 728
8989805d
TH		 729 int nr_pmp_links; /* nr of available PMP links */
730 struct ata_link *pmp_link; /* array of PMP links */
da917d69 731 struct ata_link *excl_link; /* for PMP qc exclusion */
8989805d 732
cca3974e
JG		 733 struct ata_port_stats stats;
734 struct ata_host *host;
2f1f610b 735 struct device *dev;
1da177e4 736
65f27f38 737 void *port_task_data;
52bad64d
DH		 738 struct delayed_work port_task;
739 struct delayed_work hotplug_task;
3b01b8af 740 struct work_struct scsi_rescan_task;
86e45b6b 741
14be71f4 742 unsigned int hsm_task_state;
1da177e4 743
bfd60579 744 u32 msg_enable;
a72ec4ce 745 struct list_head eh_done_q;
c6cf9e99 746 wait_queue_head_t eh_wait_q;
a1e10f7e 747 int eh_tries;
45fabbb7 748 struct completion park_req_pending;
bfd60579 749
500530f6
TH		 750 pm_message_t pm_mesg;
751 int *pm_result;
ca77329f 752 enum link_pm pm_policy;
500530f6 753
5ddf24c5
TH		 754 struct timer_list fastdrain_timer;
755 unsigned long fastdrain_cnt;
756
18f7ba4c 757 int em_message_type;
1da177e4 758 void *private_data;
fe635c7e 759
fafbae87
TH		 760#ifdef CONFIG_ATA_ACPI
761 acpi_handle acpi_handle;
c05e6ff0 762 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
fafbae87 763#endif
84bda12a
TH		 764 /* owned by EH */
765 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
1da177e4
LT		 766};
767
029cfd6b
TH		 768/* The following initializer overrides a method to NULL whether one of
769 * its parent has the method defined or not. This is equivalent to
770 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
771 * expression and thus can't be used as an initializer.
772 */
773#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
774
1da177e4 775struct ata_port_operations {
c1bc899f
TH		 776 /*
777 * Command execution
778 */
779 int (*qc_defer)(struct ata_queued_cmd *qc);
780 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
781 void (*qc_prep)(struct ata_queued_cmd *qc);
782 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
22183bf5 783 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
1da177e4 784
c1bc899f
TH		 785 /*
786 * Configuration and exception handling
787 */
788 int (*cable_detect)(struct ata_port *ap);
789 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
790 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
791 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
792 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
963e4975 793 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
1da177e4 794
c1bc899f 795 void (*dev_config)(struct ata_device *dev);
1da177e4 796
c1bc899f
TH		 797 void (*freeze)(struct ata_port *ap);
798 void (*thaw)(struct ata_port *ap);
a1efdaba
TH		 799 ata_prereset_fn_t prereset;
800 ata_reset_fn_t softreset;
801 ata_reset_fn_t hardreset;
802 ata_postreset_fn_t postreset;
803 ata_prereset_fn_t pmp_prereset;
804 ata_reset_fn_t pmp_softreset;
805 ata_reset_fn_t pmp_hardreset;
806 ata_postreset_fn_t pmp_postreset;
c1bc899f 807 void (*error_handler)(struct ata_port *ap);
c96f1732 808 void (*lost_interrupt)(struct ata_port *ap);
c1bc899f
TH		 809 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
810
811 /*
812 * Optional features
813 */
82ef04fb
TH		 814 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
815 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
c1bc899f
TH		 816 void (*pmp_attach)(struct ata_port *ap);
817 void (*pmp_detach)(struct ata_port *ap);
818 int (*enable_pm)(struct ata_port *ap, enum link_pm policy);
819 void (*disable_pm)(struct ata_port *ap);
820
821 /*
822 * Start, stop, suspend and resume
823 */
824 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
825 int (*port_resume)(struct ata_port *ap);
826 int (*port_start)(struct ata_port *ap);
827 void (*port_stop)(struct ata_port *ap);
828 void (*host_stop)(struct ata_host *host);
829
127102ae 830#ifdef CONFIG_ATA_SFF
c1bc899f
TH		 831 /*
832 * SFF / taskfile oriented ops
833 */
5682ed33
TH		 834 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
835 u8 (*sff_check_status)(struct ata_port *ap);
836 u8 (*sff_check_altstatus)(struct ata_port *ap);
837 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
838 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
839 void (*sff_exec_command)(struct ata_port *ap,
840 const struct ata_taskfile *tf);
841 unsigned int (*sff_data_xfer)(struct ata_device *dev,
842 unsigned char *buf, unsigned int buflen, int rw);
843 u8 (*sff_irq_on)(struct ata_port *);
844 void (*sff_irq_clear)(struct ata_port *);
845
c1bc899f
TH		 846 void (*bmdma_setup)(struct ata_queued_cmd *qc);
847 void (*bmdma_start)(struct ata_queued_cmd *qc);
848 void (*bmdma_stop)(struct ata_queued_cmd *qc);
849 u8 (*bmdma_status)(struct ata_port *ap);
3d47aa8e
AC		 850
851 void (*drain_fifo)(struct ata_queued_cmd *qc);
127102ae 852#endif /* CONFIG_ATA_SFF */
c1bc899f 853
18f7ba4c
KCA		 854 ssize_t (*em_show)(struct ata_port *ap, char *buf);
855 ssize_t (*em_store)(struct ata_port *ap, const char *message,
856 size_t size);
857 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
858 ssize_t (*sw_activity_store)(struct ata_device *dev,
859 enum sw_activity val);
c1bc899f
TH		 860 /*
861 * Obsolete
9ec957f2 862 */
c1bc899f
TH		 863 void (*phy_reset)(struct ata_port *ap);
864 void (*eng_timeout)(struct ata_port *ap);
029cfd6b
TH		 865
866 /*
867 * ->inherits must be the last field and all the preceding
868 * fields must be pointers.
869 */
870 const struct ata_port_operations *inherits;
1da177e4
LT		 871};
872
873struct ata_port_info {
cca3974e 874 unsigned long flags;
0c88758b 875 unsigned long link_flags;
1da177e4
LT		 876 unsigned long pio_mask;
877 unsigned long mwdma_mask;
878 unsigned long udma_mask;
029cfd6b 879 struct ata_port_operations *port_ops;
e99f8b5e 880 void *private_data;
1da177e4
LT		 881};
882
452503f9
AC		 883struct ata_timing {
884 unsigned short mode; /* ATA mode */
885 unsigned short setup; /* t1 */
886 unsigned short act8b; /* t2 for 8-bit I/O */
887 unsigned short rec8b; /* t2i for 8-bit I/O */
888 unsigned short cyc8b; /* t0 for 8-bit I/O */
889 unsigned short active; /* t2 or tD */
890 unsigned short recover; /* t2i or tK */
3ada9c12 891 unsigned short dmack_hold; /* tj */
452503f9
AC		 892 unsigned short cycle; /* t0 */
893 unsigned short udma; /* t2CYCTYP/2 */
894};
895
624d5c51
TH		 896/*
897 * Core layer - drivers/ata/libata-core.c
898 */
e9c83914
TH		 899extern const unsigned long sata_deb_timing_normal[];
900extern const unsigned long sata_deb_timing_hotplug[];
901extern const unsigned long sata_deb_timing_long[];
902
029cfd6b 903extern struct ata_port_operations ata_dummy_port_ops;
21b0ad4f 904extern const struct ata_port_info ata_dummy_port_info;
dd5b06c4 905
e9c83914
TH		 906static inline const unsigned long *
907sata_ehc_deb_timing(struct ata_eh_context *ehc)
908{
909 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
910 return sata_deb_timing_hotplug;
911 else
912 return sata_deb_timing_normal;
913}
d7bb4cc7 914
dd5b06c4
TH		 915static inline int ata_port_is_dummy(struct ata_port *ap)
916{
917 return ap->ops == &ata_dummy_port_ops;
918}
919
1da177e4 920extern void ata_port_probe(struct ata_port *);
936fd732 921extern int sata_set_spd(struct ata_link *link);
0aa1113d 922extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
aa2731ad
TH		 923extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
924 int (*check_ready)(struct ata_link *link));
936fd732
TH		 925extern int sata_link_debounce(struct ata_link *link,
926 const unsigned long *params, unsigned long deadline);
927extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
928 unsigned long deadline);
cc0680a5 929extern int sata_link_hardreset(struct ata_link *link,
9dadd45b
TH		 930 const unsigned long *timing, unsigned long deadline,
931 bool *online, int (*check_ready)(struct ata_link *));
57c9efdf
TH		 932extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
933 unsigned long deadline);
203c75b8 934extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1da177e4 935extern void ata_port_disable(struct ata_port *);
2855568b 936
f3187195 937extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
f5cda257
TH		 938extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
939 const struct ata_port_info * const * ppi, int n_ports);
b1c72916 940extern int ata_slave_link_init(struct ata_port *ap);
ecef7253 941extern int ata_host_start(struct ata_host *host);
f3187195
TH		 942extern int ata_host_register(struct ata_host *host,
943 struct scsi_host_template *sht);
f5cda257
TH		 944extern int ata_host_activate(struct ata_host *host, int irq,
945 irq_handler_t irq_handler, unsigned long irq_flags,
946 struct scsi_host_template *sht);
0529c159 947extern void ata_host_detach(struct ata_host *host);
cca3974e 948extern void ata_host_init(struct ata_host *, struct device *,
029cfd6b 949 unsigned long, struct ata_port_operations *);
193515d5 950extern int ata_scsi_detect(struct scsi_host_template *sht);
1da177e4
LT		 951extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
952extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
94be9a58
JG		 953extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
954 int cmd, void __user *arg);
80289167 955extern void ata_sas_port_destroy(struct ata_port *);
cca3974e 956extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
80289167
BK		 957 struct ata_port_info *, struct Scsi_Host *);
958extern int ata_sas_port_init(struct ata_port *);
959extern int ata_sas_port_start(struct ata_port *ap);
960extern void ata_sas_port_stop(struct ata_port *ap);
961extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
962extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
963 struct ata_port *ap);
936fd732
TH		 964extern int sata_scr_valid(struct ata_link *link);
965extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
966extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
967extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
b5b3fa38
TH		 968extern bool ata_link_online(struct ata_link *link);
969extern bool ata_link_offline(struct ata_link *link);
6ffa01d8 970#ifdef CONFIG_PM
cca3974e
JG		 971extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
972extern void ata_host_resume(struct ata_host *host);
6ffa01d8 973#endif
67846b30 974extern int ata_ratelimit(void);
c22daff4 975extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
341c2c95 976 unsigned long interval, unsigned long timeout);
436d34b3 977extern int atapi_cmd_type(u8 opcode);
9977126c
TH		 978extern void ata_tf_to_fis(const struct ata_taskfile *tf,
979 u8 pmp, int is_cmd, u8 *fis);
057ace5e 980extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
7dc951ae
TH		 981extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
982 unsigned long mwdma_mask, unsigned long udma_mask);
983extern void ata_unpack_xfermask(unsigned long xfer_mask,
984 unsigned long *pio_mask, unsigned long *mwdma_mask,
985 unsigned long *udma_mask);
986extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
987extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
988extern int ata_xfer_mode2shift(unsigned long xfer_mode);
989extern const char *ata_mode_string(unsigned long xfer_mask);
990extern unsigned long ata_id_xfermask(const u16 *id);
2dcb407e 991extern int ata_port_start(struct ata_port *ap);
31cc23b3 992extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
e46834cd 993extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
1da177e4
LT		 994extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
995 unsigned int n_elem);
057ace5e 996extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
10305f0f 997extern void ata_dev_disable(struct ata_device *adev);
6a62a04d
TH		 998extern void ata_id_string(const u16 *id, unsigned char *s,
999 unsigned int ofs, unsigned int len);
1000extern void ata_id_c_string(const u16 *id, unsigned char *s,
1001 unsigned int ofs, unsigned int len);
963e4975
AC		 1002extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1003 struct ata_taskfile *tf, u16 *id);
f686bcb8 1004extern void ata_qc_complete(struct ata_queued_cmd *qc);
79f97dad 1005extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
3373efd8 1006extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1da177e4
LT		 1007 void (*done)(struct scsi_cmnd *));
1008extern int ata_std_bios_param(struct scsi_device *sdev,
1009 struct block_device *bdev,
1010 sector_t capacity, int geom[]);
1011extern int ata_scsi_slave_config(struct scsi_device *sdev);
83c47bcb 1012extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
a6e6ce8e
TH		 1013extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1014 int queue_depth);
3373efd8 1015extern struct ata_device *ata_dev_pair(struct ata_device *adev);
0260731f 1016extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1da177e4 1017
be0d18df
AC		 1018extern int ata_cable_40wire(struct ata_port *ap);
1019extern int ata_cable_80wire(struct ata_port *ap);
1020extern int ata_cable_sata(struct ata_port *ap);
c88f90c3 1021extern int ata_cable_ignore(struct ata_port *ap);
be0d18df
AC		 1022extern int ata_cable_unknown(struct ata_port *ap);
1023
1a660164
ML		 1024extern void ata_pio_queue_task(struct ata_port *ap, void *data,
1025 unsigned long delay);
1026
624d5c51 1027/* Timing helpers */
1bc4ccff 1028extern unsigned int ata_pio_need_iordy(const struct ata_device *);
6357357c 1029extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
452503f9
AC		 1030extern int ata_timing_compute(struct ata_device *, unsigned short,
1031 struct ata_timing *, int, int);
1032extern void ata_timing_merge(const struct ata_timing *,
1033 const struct ata_timing *, struct ata_timing *,
1034 unsigned int);
a0f79b92 1035extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
452503f9 1036
624d5c51
TH		 1037/* PCI */
1038#ifdef CONFIG_PCI
1039struct pci_dev;
1040
1041struct pci_bits {
1042 unsigned int reg; /* PCI config register to read */
1043 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1044 unsigned long mask;
1045 unsigned long val;
452503f9
AC		 1046};
1047
624d5c51
TH		 1048extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1049extern void ata_pci_remove_one(struct pci_dev *pdev);
1050
1051#ifdef CONFIG_PM
1052extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1053extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1054extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1055extern int ata_pci_device_resume(struct pci_dev *pdev);
1056#endif /* CONFIG_PM */
1057#endif /* CONFIG_PCI */
1058
1059/*
1060 * ACPI - drivers/ata/libata-acpi.c
1061 */
e1ddb4b6 1062#ifdef CONFIG_ATA_ACPI
c05e6ff0
TH		 1063static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1064{
1065 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1066 return &ap->__acpi_init_gtm;
1067 return NULL;
1068}
0d02f0b2
TH		 1069int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1070int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
7c77fa4d
TH		 1071unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1072 const struct ata_acpi_gtm *gtm);
021ee9a6 1073int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
e1ddb4b6 1074#else
c05e6ff0
TH		 1075static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1076{
1077 return NULL;
1078}
7c77fa4d
TH		 1079
1080static inline int ata_acpi_stm(const struct ata_port *ap,
1081 struct ata_acpi_gtm *stm)
1082{
1083 return -ENOSYS;
1084}
1085
1086static inline int ata_acpi_gtm(const struct ata_port *ap,
1087 struct ata_acpi_gtm *stm)
1088{
1089 return -ENOSYS;
1090}
1091
1092static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1093 const struct ata_acpi_gtm *gtm)
1094{
1095 return 0;
1096}
021ee9a6
TH		 1097
1098static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1099 const struct ata_acpi_gtm *gtm)
1100{
1101 return 0;
1102}
e1ddb4b6 1103#endif
1da177e4 1104
ece1d636 1105/*
624d5c51 1106 * EH - drivers/ata/libata-eh.c
ece1d636 1107 */
7b70fc03 1108extern void ata_port_schedule_eh(struct ata_port *ap);
dbd82616 1109extern int ata_link_abort(struct ata_link *link);
7b70fc03 1110extern int ata_port_abort(struct ata_port *ap);
e3180499 1111extern int ata_port_freeze(struct ata_port *ap);
7d77b247 1112extern int sata_async_notification(struct ata_port *ap);
e3180499
TH		 1113
1114extern void ata_eh_freeze_port(struct ata_port *ap);
1115extern void ata_eh_thaw_port(struct ata_port *ap);
7b70fc03 1116
ece1d636
TH		 1117extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1118extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
10acf3b0 1119extern void ata_eh_analyze_ncq_error(struct ata_link *link);
ece1d636 1120
f5914a46
TH		 1121extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1122 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1123 ata_postreset_fn_t postreset);
a1efdaba 1124extern void ata_std_error_handler(struct ata_port *ap);
022bdb07 1125
68d1d07b
TH		 1126/*
1127 * Base operations to inherit from and initializers for sht
1128 *
1129 * Operations
1130 *
1131 * base : Common to all libata drivers.
1132 * sata : SATA controllers w/ native interface.
1133 * pmp : SATA controllers w/ PMP support.
1134 * sff : SFF ATA controllers w/o BMDMA support.
1135 * bmdma : SFF ATA controllers w/ BMDMA support.
1136 *
1137 * sht initializers
1138 *
1139 * BASE : Common to all libata drivers. The user must set
1140 * sg_tablesize and dma_boundary.
1141 * PIO : SFF ATA controllers w/ only PIO support.
1142 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1143 * dma_boundary are set to BMDMA limits.
1144 * NCQ : SATA controllers supporting NCQ. The user must set
1145 * sg_tablesize, dma_boundary and can_queue.
1146 */
1147extern const struct ata_port_operations ata_base_port_ops;
1148extern const struct ata_port_operations sata_port_ops;
45fabbb7 1149extern struct device_attribute *ata_common_sdev_attrs[];
68d1d07b
TH		 1150
1151#define ATA_BASE_SHT(drv_name) \
1152 .module = THIS_MODULE, \
1153 .name = drv_name, \
1154 .ioctl = ata_scsi_ioctl, \
1155 .queuecommand = ata_scsi_queuecmd, \
1156 .can_queue = ATA_DEF_QUEUE, \
1157 .this_id = ATA_SHT_THIS_ID, \
1158 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1159 .emulated = ATA_SHT_EMULATED, \
1160 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1161 .proc_name = drv_name, \
1162 .slave_configure = ata_scsi_slave_config, \
1163 .slave_destroy = ata_scsi_slave_destroy, \
45fabbb7
EO		 1164 .bios_param = ata_std_bios_param, \
1165 .sdev_attrs = ata_common_sdev_attrs
68d1d07b 1166
68d1d07b
TH		 1167#define ATA_NCQ_SHT(drv_name) \
1168 ATA_BASE_SHT(drv_name), \
1169 .change_queue_depth = ata_scsi_change_queue_depth
1170
071f44b1
TH		 1171/*
1172 * PMP helpers
1173 */
88fcd562 1174#ifdef CONFIG_SATA_PMP
071f44b1
TH		 1175static inline bool sata_pmp_supported(struct ata_port *ap)
1176{
1177 return ap->flags & ATA_FLAG_PMP;
1178}
1179
1180static inline bool sata_pmp_attached(struct ata_port *ap)
1181{
1182 return ap->nr_pmp_links != 0;
1183}
1184
1185static inline int ata_is_host_link(const struct ata_link *link)
1186{
b1c72916 1187 return link == &link->ap->link || link == link->ap->slave_link;
071f44b1 1188}
88fcd562
TH		 1189#else /* CONFIG_SATA_PMP */
1190static inline bool sata_pmp_supported(struct ata_port *ap)
1191{
1192 return false;
1193}
1194
1195static inline bool sata_pmp_attached(struct ata_port *ap)
1196{
1197 return false;
1198}
1199
1200static inline int ata_is_host_link(const struct ata_link *link)
1201{
1202 return 1;
1203}
1204#endif /* CONFIG_SATA_PMP */
071f44b1
TH		 1205
1206static inline int sata_srst_pmp(struct ata_link *link)
1207{
1208 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1209 return SATA_PMP_CTRL_PORT;
1210 return link->pmp;
1211}
1212
61440db6
TH		 1213/*
1214 * printk helpers
1215 */
1216#define ata_port_printk(ap, lv, fmt, args...) \
c2e366a1 1217 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
61440db6 1218
8989805d 1219#define ata_link_printk(link, lv, fmt, args...) do { \
b1c72916 1220 if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link) \
c2e366a1 1221 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
8989805d
TH		 1222 (link)->pmp , ##args); \
1223 else \
c2e366a1 1224 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
8989805d 1225 } while(0)
9af5c9c9 1226
61440db6 1227#define ata_dev_printk(dev, lv, fmt, args...) \
c2e366a1 1228 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
8989805d 1229 (dev)->link->pmp + (dev)->devno , ##args)
1da177e4 1230
f3e81b19
TH		 1231/*
1232 * ata_eh_info helpers
1233 */
cb94c1cf
TH		 1234extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1235 __attribute__ ((format (printf, 2, 3)));
1236extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1237 __attribute__ ((format (printf, 2, 3)));
b64bbc39 1238extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
f3e81b19 1239
c0b6c037
TH		 1240static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1241{
b558eddd 1242 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
f8f1e1cc 1243 ehi->flags |= ATA_EHI_HOTPLUGGED;
b558eddd 1244 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
c0b6c037
TH		 1245 ehi->err_mask |= AC_ERR_ATA_BUS;
1246}
1247
cbcdd875
TH		 1248/*
1249 * port description helpers
1250 */
1251extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1252 __attribute__ ((format (printf, 2, 3)));
1253#ifdef CONFIG_PCI
1254extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1255 const char *name);
1256#endif
1257
1da177e4
LT		 1258static inline unsigned int ata_tag_valid(unsigned int tag)
1259{
1260 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1261}
1262
2ab7db1f
TH		 1263static inline unsigned int ata_tag_internal(unsigned int tag)
1264{
83c063dd 1265 return tag == ATA_TAG_INTERNAL;
2ab7db1f
TH		 1266}
1267
5806db22
TH		 1268/*
1269 * device helpers
1270 */
e1211e3f 1271static inline unsigned int ata_class_enabled(unsigned int class)
597afd21 1272{
e0a71752
TH		 1273 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1274 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
597afd21
TH		 1275}
1276
e1211e3f 1277static inline unsigned int ata_class_disabled(unsigned int class)
1da177e4 1278{
e0a71752
TH		 1279 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1280 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
e1211e3f
TH		 1281}
1282
002c8054
TH		 1283static inline unsigned int ata_class_absent(unsigned int class)
1284{
1285 return !ata_class_enabled(class) && !ata_class_disabled(class);
1286}
1287
e1211e3f
TH		 1288static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1289{
1290 return ata_class_enabled(dev->class);
1291}
1292
1293static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1294{
1295 return ata_class_disabled(dev->class);
1da177e4
LT		 1296}
1297
002c8054
TH		 1298static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1299{
1300 return ata_class_absent(dev->class);
1301}
1302
5806db22 1303/*
f58229f8 1304 * link helpers
5806db22 1305 */
f58229f8 1306static inline int ata_link_max_devices(const struct ata_link *link)
5806db22 1307{
8989805d 1308 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
5806db22
TH		 1309 return 2;
1310 return 1;
1311}
1312
da917d69
TH		 1313static inline int ata_link_active(struct ata_link *link)
1314{
1315 return ata_tag_valid(link->active_tag) || link->sactive;
1316}
1317
1eca4365
TH		 1318/*
1319 * Iterators
1320 *
1321 * ATA_LITER_* constants are used to select link iteration mode and
1322 * ATA_DITER_* device iteration mode.
1323 *
1324 * For a custom iteration directly using ata_{link|dev}_next(), if
1325 * @link or @dev, respectively, is NULL, the first element is
1326 * returned. @dev and @link can be any valid device or link and the
1327 * next element according to the iteration mode will be returned.
1328 * After the last element, NULL is returned.
1329 */
1330enum ata_link_iter_mode {
1331 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1332 * host link. no slave link */
1333 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1334 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1335 * slave link still comes after host link */
1336};
1337
1338enum ata_dev_iter_mode {
1339 ATA_DITER_ENABLED,
1340 ATA_DITER_ENABLED_REVERSE,
1341 ATA_DITER_ALL,
1342 ATA_DITER_ALL_REVERSE,
1343};
1344
1345extern struct ata_link *ata_link_next(struct ata_link *link,
1346 struct ata_port *ap,
1347 enum ata_link_iter_mode mode);
1348
1349extern struct ata_device *ata_dev_next(struct ata_device *dev,
1350 struct ata_link *link,
1351 enum ata_dev_iter_mode mode);
1352
1353/*
1354 * Shortcut notation for iterations
1355 *
1356 * ata_for_each_link() iterates over each link of @ap according to
1357 * @mode. @link points to the current link in the loop. @link is
1358 * NULL after loop termination. ata_for_each_dev() works the same way
1359 * except that it iterates over each device of @link.
1360 *
1361 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1362 * specified when using the following shorthand notations. Only the
1363 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1364 * specified. This not only increases brevity but also makes it
1365 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1366 */
1367#define ata_for_each_link(link, ap, mode) \
1368 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1369 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1370
1371#define ata_for_each_dev(dev, link, mode) \
1372 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1373 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
5806db22 1374
6d1245bf
TH		 1375/**
1376 * ata_ncq_enabled - Test whether NCQ is enabled
1377 * @dev: ATA device to test for
1378 *
1379 * LOCKING:
1380 * spin_lock_irqsave(host lock)
1381 *
1382 * RETURNS:
1383 * 1 if NCQ is enabled for @dev, 0 otherwise.
1384 */
1385static inline int ata_ncq_enabled(struct ata_device *dev)
1386{
1387 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1388 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1389}
0baab86b 1390
1da177e4
LT		 1391static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1392{
1393 qc->tf.ctl |= ATA_NIEN;
1394}
1395
f69499f4
TH		 1396static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1397 unsigned int tag)
1da177e4
LT		 1398{
1399 if (likely(ata_tag_valid(tag)))
1400 return &ap->qcmd[tag];
1401 return NULL;
1402}
1403
f69499f4
TH		 1404static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1405 unsigned int tag)
1406{
1407 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1408
1409 if (unlikely(!qc) || !ap->ops->error_handler)
1410 return qc;
1411
1412 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1413 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1414 return qc;
1415
1416 return NULL;
1417}
1418
aacda375
TH		 1419static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1420{
1421 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1422}
1423
3373efd8 1424static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1da177e4
LT		 1425{
1426 memset(tf, 0, sizeof(*tf));
1427
9af5c9c9 1428 tf->ctl = dev->link->ap->ctl;
3373efd8 1429 if (dev->devno == 0)
1da177e4
LT		 1430 tf->device = ATA_DEVICE_OBS;
1431 else
1432 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1433}
1434
2c13b7ce
JG		 1435static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1436{
501e0c50 1437 qc->dma_dir = DMA_NONE;
ff2aeb1e 1438 qc->sg = NULL;
2c13b7ce 1439 qc->flags = 0;
87260216
JA		 1440 qc->cursg = NULL;
1441 qc->cursg_ofs = 0;
aacda375 1442 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
7a801184 1443 qc->n_elem = 0;
a22e2eb0 1444 qc->err_mask = 0;
5a5dbd18 1445 qc->sect_size = ATA_SECT_SIZE;
2c13b7ce 1446
3373efd8 1447 ata_tf_init(qc->dev, &qc->tf);
e61e0672
TH		 1448
1449 /* init result_tf such that it indicates normal completion */
1450 qc->result_tf.command = ATA_DRDY;
1451 qc->result_tf.feature = 0;
2c13b7ce
JG		 1452}
1453
057ace5e 1454static inline int ata_try_flush_cache(const struct ata_device *dev)
1da177e4
LT		 1455{
1456 return ata_id_wcache_enabled(dev->id) ||
1457 ata_id_has_flush(dev->id) ||
1458 ata_id_has_flush_ext(dev->id);
1459}
1460
a7dac447
JG		 1461static inline unsigned int ac_err_mask(u8 status)
1462{
3655d1d3 1463 if (status & (ATA_BUSY | ATA_DRQ))
11a56d24 1464 return AC_ERR_HSM;
a7dac447
JG		 1465 if (status & (ATA_ERR | ATA_DF))
1466 return AC_ERR_DEV;
1467 return 0;
1468}
1469
1470static inline unsigned int __ac_err_mask(u8 status)
1471{
1472 unsigned int mask = ac_err_mask(status);
1473 if (mask == 0)
1474 return AC_ERR_OTHER;
1475 return mask;
1476}
1477
35bb94b1
JG		 1478static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1479{
4911487a 1480 return *(struct ata_port **)&host->hostdata[0];
35bb94b1
JG		 1481}
1482
78ab88f0
TH		 1483static inline int ata_check_ready(u8 status)
1484{
005b1f74
JG		 1485 if (!(status & ATA_BUSY))
1486 return 1;
78ab88f0
TH		 1487
1488 /* 0xff indicates either no device or device not ready */
1489 if (status == 0xff)
1490 return -ENODEV;
1491
005b1f74 1492 return 0;
78ab88f0
TH		 1493}
1494
341c2c95
TH		 1495static inline unsigned long ata_deadline(unsigned long from_jiffies,
1496 unsigned long timeout_msecs)
1497{
1498 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1499}
1500
b15b3eba
AC		 1501/* Don't open code these in drivers as there are traps. Firstly the range may
1502 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1503 > UDMA_0. Dyma ddreigiau */
1504
1505static inline int ata_using_mwdma(struct ata_device *adev)
1506{
1507 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1508 return 1;
1509 return 0;
1510}
1511
1512static inline int ata_using_udma(struct ata_device *adev)
1513{
1514 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1515 return 1;
1516 return 0;
1517}
1518
1519static inline int ata_dma_enabled(struct ata_device *adev)
1520{
1521 return (adev->dma_mode == 0xFF ? 0 : 1);
1522}
48515f6c
TH		 1523
1524/**************************************************************************
1525 * PMP - drivers/ata/libata-pmp.c
1526 */
88fcd562
TH		 1527#ifdef CONFIG_SATA_PMP
1528
48515f6c
TH		 1529extern const struct ata_port_operations sata_pmp_port_ops;
1530
1531extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1532extern void sata_pmp_error_handler(struct ata_port *ap);
1533
88fcd562
TH		 1534#else /* CONFIG_SATA_PMP */
1535
1536#define sata_pmp_port_ops sata_port_ops
1537#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1538#define sata_pmp_error_handler ata_std_error_handler
1539
1540#endif /* CONFIG_SATA_PMP */
1541
48515f6c 1542
624d5c51
TH		 1543/**************************************************************************
1544 * SFF - drivers/ata/libata-sff.c
1545 */
127102ae
TH		 1546#ifdef CONFIG_ATA_SFF
1547
624d5c51
TH		 1548extern const struct ata_port_operations ata_sff_port_ops;
1549extern const struct ata_port_operations ata_bmdma_port_ops;
871af121 1550extern const struct ata_port_operations ata_bmdma32_port_ops;
624d5c51
TH		 1551
1552/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1553#define ATA_PIO_SHT(drv_name) \
1554 ATA_BASE_SHT(drv_name), \
1555 .sg_tablesize = LIBATA_MAX_PRD, \
1556 .dma_boundary = ATA_DMA_BOUNDARY
1557
1558#define ATA_BMDMA_SHT(drv_name) \
1559 ATA_BASE_SHT(drv_name), \
1560 .sg_tablesize = LIBATA_MAX_PRD, \
1561 .dma_boundary = ATA_DMA_BOUNDARY
1562
9363c382
TH		 1563extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1564extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1565extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1566extern u8 ata_sff_check_status(struct ata_port *ap);
a57c1bad
AC		 1567extern void ata_sff_pause(struct ata_port *ap);
1568extern void ata_sff_dma_pause(struct ata_port *ap);
9363c382
TH		 1569extern int ata_sff_busy_sleep(struct ata_port *ap,
1570 unsigned long timeout_pat, unsigned long timeout);
705e76be 1571extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
9363c382
TH		 1572extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1573extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1574extern void ata_sff_exec_command(struct ata_port *ap,
1575 const struct ata_taskfile *tf);
1576extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
624d5c51 1577 unsigned char *buf, unsigned int buflen, int rw);
871af121
AC		 1578extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1579 unsigned char *buf, unsigned int buflen, int rw);
9363c382 1580extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
624d5c51 1581 unsigned char *buf, unsigned int buflen, int rw);
9363c382
TH		 1582extern u8 ata_sff_irq_on(struct ata_port *ap);
1583extern void ata_sff_irq_clear(struct ata_port *ap);
1584extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1585 u8 status, int in_wq);
1586extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
22183bf5 1587extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
9363c382
TH		 1588extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1589 struct ata_queued_cmd *qc);
1590extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
c96f1732 1591extern void ata_sff_lost_interrupt(struct ata_port *ap);
9363c382
TH		 1592extern void ata_sff_freeze(struct ata_port *ap);
1593extern void ata_sff_thaw(struct ata_port *ap);
1594extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1595extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1596 u8 *r_err);
705e76be
TH		 1597extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1598 unsigned long deadline);
9363c382 1599extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
624d5c51 1600 unsigned long deadline);
9363c382
TH		 1601extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1602 unsigned long deadline);
1603extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
3d47aa8e 1604extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
9363c382
TH		 1605extern void ata_sff_error_handler(struct ata_port *ap);
1606extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
624d5c51 1607extern int ata_sff_port_start(struct ata_port *ap);
e3cf95dd 1608extern int ata_sff_port_start32(struct ata_port *ap);
9363c382
TH		 1609extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1610extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1611 unsigned long xfer_mask);
624d5c51
TH		 1612extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1613extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1614extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1615extern u8 ata_bmdma_status(struct ata_port *ap);
1616extern void ata_bus_reset(struct ata_port *ap);
1617
1618#ifdef CONFIG_PCI
9363c382
TH		 1619extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1620extern int ata_pci_bmdma_init(struct ata_host *host);
1621extern int ata_pci_sff_init_host(struct ata_host *host);
1622extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
624d5c51
TH		 1623 const struct ata_port_info * const * ppi,
1624 struct ata_host **r_host);
9363c382 1625extern int ata_pci_sff_activate_host(struct ata_host *host,
624d5c51
TH		 1626 irq_handler_t irq_handler,
1627 struct scsi_host_template *sht);
9363c382
TH		 1628extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1629 const struct ata_port_info * const * ppi,
1630 struct scsi_host_template *sht, void *host_priv);
624d5c51
TH		 1631#endif /* CONFIG_PCI */
1632
624d5c51 1633/**
9363c382 1634 * ata_sff_busy_wait - Wait for a port status register
624d5c51
TH		 1635 * @ap: Port to wait for.
1636 * @bits: bits that must be clear
1637 * @max: number of 10uS waits to perform
1638 *
1639 * Waits up to max*10 microseconds for the selected bits in the port's
1640 * status register to be cleared.
1641 * Returns final value of status register.
1642 *
1643 * LOCKING:
1644 * Inherited from caller.
1645 */
9363c382
TH		 1646static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1647 unsigned int max)
624d5c51
TH		 1648{
1649 u8 status;
1650
1651 do {
1652 udelay(10);
5682ed33 1653 status = ap->ops->sff_check_status(ap);
624d5c51
TH		 1654 max--;
1655 } while (status != 0xff && (status & bits) && (max > 0));
1656
1657 return status;
1658}
1659
1660/**
1661 * ata_wait_idle - Wait for a port to be idle.
1662 * @ap: Port to wait for.
1663 *
1664 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1665 * Returns final value of status register.
1666 *
1667 * LOCKING:
1668 * Inherited from caller.
1669 */
1670static inline u8 ata_wait_idle(struct ata_port *ap)
1671{
9363c382 1672 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
624d5c51
TH		 1673
1674#ifdef ATA_DEBUG
1675 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1676 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1677 status);
1678#endif
1679
1680 return status;
1681}
127102ae 1682#endif /* CONFIG_ATA_SFF */
624d5c51 1683
1da177e4 1684#endif /* __LINUX_LIBATA_H__ */
Ubuntu Artful kernel mirror