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