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