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