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