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