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