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