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