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