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