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