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