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