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