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