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