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