]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/libata.h
libata: kill ATA_EHI_RESUME_LINK
[mirror_ubuntu-bionic-kernel.git] / include / linux / libata.h
CommitLineData
1da177e4 1/*
af36d7f0
JG
2 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
3 * Copyright 2003-2005 Jeff Garzik
4 *
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
9 * any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19 *
20 *
21 * libata documentation is available via 'make {ps|pdf}docs',
22 * as Documentation/DocBook/libata.*
23 *
1da177e4
LT
24 */
25
26#ifndef __LINUX_LIBATA_H__
27#define __LINUX_LIBATA_H__
28
29#include <linux/delay.h>
30#include <linux/interrupt.h>
1c72d8d9 31#include <linux/dma-mapping.h>
87260216 32#include <linux/scatterlist.h>
f0d36efd 33#include <linux/io.h>
1da177e4
LT
34#include <linux/ata.h>
35#include <linux/workqueue.h>
35bb94b1 36#include <scsi/scsi_host.h>
11ef697b 37#include <linux/acpi.h>
ceb0c642 38#include <linux/cdrom.h>
1da177e4 39
a6d967a4
JG
40/*
41 * Define if arch has non-standard setup. This is a _PCI_ standard
42 * not a legacy or ISA standard.
43 */
44#ifdef CONFIG_ATA_NONSTANDARD
2ec7df04 45#include <asm/libata-portmap.h>
a6d967a4
JG
46#else
47#include <asm-generic/libata-portmap.h>
48#endif
2ec7df04 49
1da177e4 50/*
bfd60579
RD
51 * compile-time options: to be removed as soon as all the drivers are
52 * converted to the new debugging mechanism
1da177e4
LT
53 */
54#undef ATA_DEBUG /* debugging output */
55#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
56#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
57#undef ATA_NDEBUG /* define to disable quick runtime checks */
1da177e4
LT
58
59
60/* note: prints function name for you */
61#ifdef ATA_DEBUG
62#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63#ifdef ATA_VERBOSE_DEBUG
64#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
65#else
66#define VPRINTK(fmt, args...)
67#endif /* ATA_VERBOSE_DEBUG */
68#else
69#define DPRINTK(fmt, args...)
70#define VPRINTK(fmt, args...)
71#endif /* ATA_DEBUG */
72
2c13b7ce
JG
73#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
74
bfd60579
RD
75/* NEW: debug levels */
76#define HAVE_LIBATA_MSG 1
77
78enum {
79 ATA_MSG_DRV = 0x0001,
80 ATA_MSG_INFO = 0x0002,
81 ATA_MSG_PROBE = 0x0004,
82 ATA_MSG_WARN = 0x0008,
83 ATA_MSG_MALLOC = 0x0010,
84 ATA_MSG_CTL = 0x0020,
85 ATA_MSG_INTR = 0x0040,
86 ATA_MSG_ERR = 0x0080,
87};
88
89#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
90#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
91#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
92#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
93#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
95#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
96#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
97
98static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
99{
100 if (dval < 0 || dval >= (sizeof(u32) * 8))
101 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
102 if (!dval)
103 return 0;
104 return (1 << dval) - 1;
105}
106
1da177e4
LT
107/* defines only for the constants which don't work well as enums */
108#define ATA_TAG_POISON 0xfafbfcfdU
109
1da177e4
LT
110enum {
111 /* various global constants */
112 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
d26fc955 113 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
1da177e4
LT
114 ATA_MAX_PORTS = 8,
115 ATA_DEF_QUEUE = 1,
2ab7db1f 116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
a6e6ce8e 117 ATA_MAX_QUEUE = 32,
2ab7db1f 118 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
1da177e4
LT
119 ATA_MAX_BUS = 2,
120 ATA_DEF_BUSY_WAIT = 10000,
121 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
122
140b5e59
TH
123 ATAPI_MAX_DRAIN = 16 << 10,
124
1da177e4
LT
125 ATA_SHT_EMULATED = 1,
126 ATA_SHT_CMD_PER_LUN = 1,
127 ATA_SHT_THIS_ID = -1,
cf482935 128 ATA_SHT_USE_CLUSTERING = 1,
1da177e4
LT
129
130 /* struct ata_device stuff */
949b38af
TH
131 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
132 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
029f5468 133 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
88e49034 134 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
6fc49adb 135 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
6746544c
TH
136 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
137 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
7d77b247 138 ATA_DFLAG_AN = (1 << 7), /* AN configured */
ca77329f
KCA
139 ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */
140 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */
91163006 141 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
2557164e 142 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
949b38af 143
2557164e
KCA
144 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
145 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
146 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */
054a5fba 147 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
00115e0f 148 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
f20ded38 149 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
1da177e4 150
f20ded38
TH
151 ATA_DFLAG_DETACH = (1 << 24),
152 ATA_DFLAG_DETACHED = (1 << 25),
abdda733 153
1da177e4
LT
154 ATA_DEV_UNKNOWN = 0, /* unknown device */
155 ATA_DEV_ATA = 1, /* ATA device */
156 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
157 ATA_DEV_ATAPI = 3, /* ATAPI device */
158 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
e0a71752
TH
159 ATA_DEV_PMP = 5, /* SATA port multiplier */
160 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
161 ATA_DEV_SEMB = 7, /* SEMB */
162 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
163 ATA_DEV_NONE = 9, /* no device */
1da177e4 164
0c88758b 165 /* struct ata_link flags */
0c88758b
TH
166 ATA_LFLAG_SKIP_D2H_BSY = (1 << 1), /* can't wait for the first D2H
167 * Register FIS clearing BSY */
ae791c05
TH
168 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
169 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
170 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
171 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
fd995f70 172 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
f9df58cb 173 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
0c88758b 174
1da177e4 175 /* struct ata_port flags */
949b38af 176 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
1da177e4 177 /* (doesn't imply presence) */
949b38af
TH
178 ATA_FLAG_SATA = (1 << 1),
179 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
180 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
181 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
182 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
183 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
184 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
185 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
7395acb2
TH
186 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
187 * doesn't handle PIO interrupts */
188 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
7395acb2 189 ATA_FLAG_DEBUGMSG = (1 << 13),
b2a8bbe6 190 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
f834e49f 191 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
3cadbcc0 192 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
9f45cbd3 193 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
e0a71752 194 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
ca77329f 195 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */
949b38af 196
b51e9e5d
TH
197 /* The following flag belongs to ap->pflags but is kept in
198 * ap->flags because it's referenced in many LLDs and will be
199 * removed in not-too-distant future.
200 */
201 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
202
203 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
9ec957f2 204
b51e9e5d
TH
205 /* struct ata_port pflags */
206 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
207 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
208 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
209 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
210 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
211 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
212 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
f4d6d004 213 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
afaa5c37 214 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
949b38af 215
b51e9e5d 216 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
500530f6 217 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
c05e6ff0 218 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
949b38af
TH
219
220 /* struct ata_queued_cmd flags */
221 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
001102d7 222 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
27197367 223 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
e61e0672 224 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
da917d69 225 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
e027bd36 226 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
e61e0672 227
9ec957f2
TH
228 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
229 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
230 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
1da177e4 231
4e5ec5db 232 /* host set flags */
cca3974e 233 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
ecef7253 234 ATA_HOST_STARTED = (1 << 1), /* Host started */
9bec2e38 235
b8b275ef
TH
236 /* bits 24:31 of host->flags are reserved for LLD specific flags */
237
1da177e4 238 /* various lengths of time */
8d238e01
AC
239 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
240 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
a2a7a662
TH
241 ATA_TMOUT_INTERNAL = 30 * HZ,
242 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
1da177e4 243
88ff6eaf
TH
244 /* FIXME: GoVault needs 2s but we can't afford that without
245 * parallel probing. 800ms is enough for iVDR disk
246 * HHD424020F7SV00. Increase to 2secs when parallel probing
247 * is in place.
248 */
249 ATA_TMOUT_FF_WAIT = 4 * HZ / 5,
250
1da177e4
LT
251 /* ATA bus states */
252 BUS_UNKNOWN = 0,
253 BUS_DMA = 1,
254 BUS_IDLE = 2,
255 BUS_NOINTR = 3,
256 BUS_NODATA = 4,
257 BUS_TIMER = 5,
258 BUS_PIO = 6,
259 BUS_EDD = 7,
260 BUS_IDENTIFY = 8,
261 BUS_PACKET = 9,
262
263 /* SATA port states */
264 PORT_UNKNOWN = 0,
265 PORT_ENABLED = 1,
266 PORT_DISABLED = 2,
267
268 /* encoding various smaller bitmaps into a single
7dc951ae 269 * unsigned long bitmap
1da177e4 270 */
70cd071e
TH
271 ATA_NR_PIO_MODES = 7,
272 ATA_NR_MWDMA_MODES = 5,
273 ATA_NR_UDMA_MODES = 8,
1da7b0d0
TH
274
275 ATA_SHIFT_PIO = 0,
70cd071e
TH
276 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
277 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
278
cedc9a47
JG
279 /* size of buffer to pad xfers ending on unaligned boundaries */
280 ATA_DMA_PAD_SZ = 4,
949b38af 281
0c247c55
TH
282 /* ering size */
283 ATA_ERING_SIZE = 32,
284
31cc23b3
TH
285 /* return values for ->qc_defer */
286 ATA_DEFER_LINK = 1,
287 ATA_DEFER_PORT = 2,
288
f3e81b19
TH
289 /* desc_len for ata_eh_info and context */
290 ATA_EH_DESC_LEN = 80,
291
9be1e979
TH
292 /* reset / recovery action types */
293 ATA_EH_REVALIDATE = (1 << 0),
cf480626
TH
294 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
295 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
296 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
f9df58cb 297 ATA_EH_ENABLE_LINK = (1 << 3),
3ec25ebd 298 ATA_EH_LPM = (1 << 4), /* link power management action */
9be1e979 299
9666f400 300 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
9be1e979 301
f3e81b19 302 /* ata_eh_info->flags */
abdda733 303 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
1cdaf534
TH
304 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
305 ATA_EHI_QUIET = (1 << 3), /* be quiet */
abdda733 306
0d64a233
TH
307 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
308 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
309 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
310 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
311 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
f3e81b19 312
0d64a233 313 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
13abf50d 314
a1e10f7e
TH
315 /* max tries if error condition is still set after ->error_handler */
316 ATA_EH_MAX_TRIES = 5,
ad9e2762 317
14d2bac1
TH
318 /* how hard are we gonna try to probe/recover devices */
319 ATA_PROBE_MAX_TRIES = 3,
022bdb07 320 ATA_EH_DEV_TRIES = 3,
e0a71752
TH
321 ATA_EH_PMP_TRIES = 5,
322 ATA_EH_PMP_LINK_TRIES = 3,
323
324 SATA_PMP_SCR_TIMEOUT = 250,
f5914a46 325
93590859
AC
326 /* Horkage types. May be set by libata or controller on drives
327 (some horkage may be drive/controller pair dependant */
328
329 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
6919a0a6
AC
330 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
331 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
18d6e9d5 332 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
16c55b03 333 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
e31e8531 334 ATA_HORKAGE_SKIP_PM = (1 << 5), /* Skip PM operations */
93328e11 335 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
ca77329f 336 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
6bbfd53d 337 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
2d3b8eea 338 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
b3a70601 339
2dcb407e 340 /* DMA mask for user DMA control: User visible values; DO NOT
b3a70601
AC
341 renumber */
342 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
343 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
344 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
ceb0c642
TH
345
346 /* ATAPI command types */
347 ATAPI_READ = 0, /* READs */
348 ATAPI_WRITE = 1, /* WRITEs */
349 ATAPI_READ_CD = 2, /* READ CD [MSF] */
e52dcc48
TH
350 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
351 ATAPI_MISC = 4, /* the rest */
1da177e4
LT
352};
353
7dc951ae
TH
354enum ata_xfer_mask {
355 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
356 << ATA_SHIFT_PIO,
357 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
358 << ATA_SHIFT_MWDMA,
359 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
360 << ATA_SHIFT_UDMA,
361};
362
14be71f4 363enum hsm_task_states {
c56b14d2 364 HSM_ST_IDLE, /* no command on going */
71527647
AL
365 HSM_ST_FIRST, /* (waiting the device to)
366 write CDB or first data block */
c56b14d2
AL
367 HSM_ST, /* (waiting the device to) transfer data */
368 HSM_ST_LAST, /* (waiting the device to) complete command */
c56b14d2 369 HSM_ST_ERR, /* error */
1da177e4
LT
370};
371
a7dac447 372enum ata_completion_errors {
11a56d24
TH
373 AC_ERR_DEV = (1 << 0), /* device reported error */
374 AC_ERR_HSM = (1 << 1), /* host state machine violation */
375 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
376 AC_ERR_MEDIA = (1 << 3), /* media error */
377 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
378 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
379 AC_ERR_SYSTEM = (1 << 6), /* system error */
380 AC_ERR_INVALID = (1 << 7), /* invalid argument */
381 AC_ERR_OTHER = (1 << 8), /* unknown */
55a8e2c8 382 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
5335b729 383 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
a7dac447
JG
384};
385
1da177e4
LT
386/* forward declarations */
387struct scsi_device;
388struct ata_port_operations;
389struct ata_port;
cc0680a5 390struct ata_link;
1da177e4
LT
391struct ata_queued_cmd;
392
393/* typedefs */
77853bf2 394typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
cc0680a5
TH
395typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
396typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
d4b2bab4 397 unsigned long deadline);
cc0680a5 398typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
1da177e4 399
ca77329f
KCA
400/*
401 * host pm policy: If you alter this, you also need to alter libata-scsi.c
402 * (for the ascii descriptions)
403 */
404enum link_pm {
405 NOT_AVAILABLE,
406 MIN_POWER,
407 MAX_PERFORMANCE,
408 MEDIUM_POWER,
409};
410extern struct class_device_attribute class_device_attr_link_power_management_policy;
411
1da177e4 412struct ata_ioports {
0d5ff566
TH
413 void __iomem *cmd_addr;
414 void __iomem *data_addr;
415 void __iomem *error_addr;
416 void __iomem *feature_addr;
417 void __iomem *nsect_addr;
418 void __iomem *lbal_addr;
419 void __iomem *lbam_addr;
420 void __iomem *lbah_addr;
421 void __iomem *device_addr;
422 void __iomem *status_addr;
423 void __iomem *command_addr;
424 void __iomem *altstatus_addr;
425 void __iomem *ctl_addr;
426 void __iomem *bmdma_addr;
427 void __iomem *scr_addr;
1da177e4
LT
428};
429
cca3974e 430struct ata_host {
1da177e4
LT
431 spinlock_t lock;
432 struct device *dev;
0d5ff566 433 void __iomem * const *iomap;
1da177e4
LT
434 unsigned int n_ports;
435 void *private_data;
057ace5e 436 const struct ata_port_operations *ops;
5444a6f4 437 unsigned long flags;
fafbae87
TH
438#ifdef CONFIG_ATA_ACPI
439 acpi_handle acpi_handle;
440#endif
032af1ce 441 struct ata_port *simplex_claimed; /* channel owning the DMA */
f0eb62b8 442 struct ata_port *ports[0];
1da177e4
LT
443};
444
445struct ata_queued_cmd {
446 struct ata_port *ap;
447 struct ata_device *dev;
448
449 struct scsi_cmnd *scsicmd;
450 void (*scsidone)(struct scsi_cmnd *);
451
452 struct ata_taskfile tf;
453 u8 cdb[ATAPI_CDB_LEN];
454
455 unsigned long flags; /* ATA_QCFLAG_xxx */
456 unsigned int tag;
457 unsigned int n_elem;
458
459 int dma_dir;
460
5a5dbd18 461 unsigned int sect_size;
cedc9a47 462
1da177e4 463 unsigned int nbytes;
aacda375 464 unsigned int extrabytes;
1da177e4
LT
465 unsigned int curbytes;
466
87260216 467 struct scatterlist *cursg;
1da177e4
LT
468 unsigned int cursg_ofs;
469
470 struct scatterlist sgent;
1da177e4 471
ff2aeb1e 472 struct scatterlist *sg;
1da177e4 473
a22e2eb0 474 unsigned int err_mask;
e61e0672 475 struct ata_taskfile result_tf;
1da177e4
LT
476 ata_qc_cb_t complete_fn;
477
1da177e4 478 void *private_data;
1c50dc83 479 void *lldd_task;
1da177e4
LT
480};
481
cca3974e 482struct ata_port_stats {
1da177e4
LT
483 unsigned long unhandled_irq;
484 unsigned long idle_irq;
485 unsigned long rw_reqbuf;
486};
487
0c247c55 488struct ata_ering_entry {
3884f7b0 489 unsigned int eflags;
0c247c55
TH
490 unsigned int err_mask;
491 u64 timestamp;
492};
493
494struct ata_ering {
495 int cursor;
496 struct ata_ering_entry ring[ATA_ERING_SIZE];
497};
498
1da177e4 499struct ata_device {
9af5c9c9 500 struct ata_link *link;
72fa4b74 501 unsigned int devno; /* 0 or 1 */
1da177e4 502 unsigned long flags; /* ATA_DFLAG_xxx */
75683fe7 503 unsigned int horkage; /* List of broken features */
3edebac4 504 struct scsi_device *sdev; /* attached SCSI device */
fafbae87
TH
505#ifdef CONFIG_ATA_ACPI
506 acpi_handle acpi_handle;
398e0782 507 union acpi_object *gtf_cache;
fafbae87 508#endif
72fa4b74
TH
509 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
510 u64 n_sectors; /* size of device, if ATA */
1da177e4 511 unsigned int class; /* ATA_DEV_xxx */
e0a71752
TH
512
513 union {
514 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
515 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
516 };
517
1da177e4
LT
518 u8 pio_mode;
519 u8 dma_mode;
520 u8 xfer_mode;
521 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
522
8cbd6df1
AL
523 unsigned int multi_count; /* sectors count for
524 READ/WRITE MULTIPLE */
b00eec1d 525 unsigned int max_sectors; /* per-device max sectors */
6e7846e9 526 unsigned int cdb_len;
8bf62ece 527
acf356b1 528 /* per-dev xfer mask */
7dc951ae
TH
529 unsigned long pio_mask;
530 unsigned long mwdma_mask;
531 unsigned long udma_mask;
acf356b1 532
8bf62ece
AL
533 /* for CHS addressing */
534 u16 cylinders; /* Number of cylinders */
535 u16 heads; /* Number of heads */
536 u16 sectors; /* Number of sectors per track */
0c247c55
TH
537
538 /* error history */
539 struct ata_ering ering;
7d47e8d4 540 int spdn_cnt;
1da177e4
LT
541};
542
72fa4b74
TH
543/* Offset into struct ata_device. Fields above it are maintained
544 * acress device init. Fields below are zeroed.
545 */
546#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
547
f3e81b19
TH
548struct ata_eh_info {
549 struct ata_device *dev; /* offending device */
550 u32 serror; /* SError from LLDD */
551 unsigned int err_mask; /* port-wide err_mask */
552 unsigned int action; /* ATA_EH_* action mask */
47005f25 553 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
f3e81b19 554 unsigned int flags; /* ATA_EHI_* flags */
abdda733 555
abdda733
TH
556 unsigned int probe_mask;
557
f3e81b19
TH
558 char desc[ATA_EH_DESC_LEN];
559 int desc_len;
560};
561
562struct ata_eh_context {
563 struct ata_eh_info i;
564 int tries[ATA_MAX_DEVICES];
abdda733
TH
565 unsigned int classes[ATA_MAX_DEVICES];
566 unsigned int did_probe_mask;
00115e0f
TH
567 unsigned int saved_ncq_enabled;
568 u8 saved_xfer_mode[ATA_MAX_DEVICES];
f3e81b19
TH
569};
570
64578a3d
TH
571struct ata_acpi_drive
572{
573 u32 pio;
574 u32 dma;
575} __packed;
576
577struct ata_acpi_gtm {
578 struct ata_acpi_drive drive[2];
579 u32 flags;
580} __packed;
581
9af5c9c9
TH
582struct ata_link {
583 struct ata_port *ap;
8989805d 584 int pmp; /* port multiplier port # */
9af5c9c9
TH
585
586 unsigned int active_tag; /* active tag on this link */
587 u32 sactive; /* active NCQ commands */
588
0c88758b
TH
589 unsigned int flags; /* ATA_LFLAG_xxx */
590
9af5c9c9
TH
591 unsigned int hw_sata_spd_limit;
592 unsigned int sata_spd_limit;
593 unsigned int sata_spd; /* current SATA PHY speed */
594
595 /* record runtime error info, protected by host_set lock */
596 struct ata_eh_info eh_info;
597 /* EH context */
598 struct ata_eh_context eh_context;
599
600 struct ata_device device[ATA_MAX_DEVICES];
601};
602
1da177e4 603struct ata_port {
cca3974e 604 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
057ace5e 605 const struct ata_port_operations *ops;
ba6a1308 606 spinlock_t *lock;
1da177e4 607 unsigned long flags; /* ATA_FLAG_xxx */
b51e9e5d 608 unsigned int pflags; /* ATA_PFLAG_xxx */
44877b4e
TH
609 unsigned int print_id; /* user visible unique port ID */
610 unsigned int port_no; /* 0 based port no. inside the host */
1da177e4
LT
611
612 struct ata_prd *prd; /* our SG list */
613 dma_addr_t prd_dma; /* and its DMA mapping */
614
615 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
616
617 u8 ctl; /* cache of ATA control register */
618 u8 last_ctl; /* Cache last written value */
1da177e4
LT
619 unsigned int pio_mask;
620 unsigned int mwdma_mask;
621 unsigned int udma_mask;
622 unsigned int cbl; /* cable type; ATA_CBL_xxx */
1da177e4
LT
623
624 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
6cec4a39 625 unsigned long qc_allocated;
dedaf2b0 626 unsigned int qc_active;
da917d69 627 int nr_active_links; /* #links with active qcs */
dedaf2b0 628
9af5c9c9 629 struct ata_link link; /* host default link */
1da177e4 630
8989805d
TH
631 int nr_pmp_links; /* nr of available PMP links */
632 struct ata_link *pmp_link; /* array of PMP links */
da917d69 633 struct ata_link *excl_link; /* for PMP qc exclusion */
8989805d 634
cca3974e
JG
635 struct ata_port_stats stats;
636 struct ata_host *host;
2f1f610b 637 struct device *dev;
1da177e4 638
65f27f38 639 void *port_task_data;
52bad64d
DH
640 struct delayed_work port_task;
641 struct delayed_work hotplug_task;
3b01b8af 642 struct work_struct scsi_rescan_task;
86e45b6b 643
14be71f4 644 unsigned int hsm_task_state;
1da177e4 645
bfd60579 646 u32 msg_enable;
a72ec4ce 647 struct list_head eh_done_q;
c6cf9e99 648 wait_queue_head_t eh_wait_q;
a1e10f7e 649 int eh_tries;
bfd60579 650
500530f6
TH
651 pm_message_t pm_mesg;
652 int *pm_result;
ca77329f 653 enum link_pm pm_policy;
500530f6 654
5ddf24c5
TH
655 struct timer_list fastdrain_timer;
656 unsigned long fastdrain_cnt;
657
1da177e4 658 void *private_data;
fe635c7e 659
fafbae87
TH
660#ifdef CONFIG_ATA_ACPI
661 acpi_handle acpi_handle;
c05e6ff0 662 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
fafbae87 663#endif
fe635c7e 664 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
1da177e4
LT
665};
666
667struct ata_port_operations {
cd0d3bbc 668 void (*dev_config) (struct ata_device *);
1da177e4
LT
669
670 void (*set_piomode) (struct ata_port *, struct ata_device *);
671 void (*set_dmamode) (struct ata_port *, struct ata_device *);
a76b62ca 672 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
1da177e4 673
057ace5e 674 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT
675 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
676
057ace5e 677 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT
678 u8 (*check_status)(struct ata_port *ap);
679 u8 (*check_altstatus)(struct ata_port *ap);
1da177e4
LT
680 void (*dev_select)(struct ata_port *ap, unsigned int device);
681
c19ba8af 682 void (*phy_reset) (struct ata_port *ap); /* obsolete */
0260731f 683 int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
c19ba8af 684
be0d18df
AC
685 int (*cable_detect) (struct ata_port *ap);
686
b229a7b0 687 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
1da177e4
LT
688
689 void (*bmdma_setup) (struct ata_queued_cmd *qc);
690 void (*bmdma_start) (struct ata_queued_cmd *qc);
691
55dba312
TH
692 unsigned int (*data_xfer) (struct ata_device *dev, unsigned char *buf,
693 unsigned int buflen, int rw);
a6b2c5d4 694
31cc23b3 695 int (*qc_defer) (struct ata_queued_cmd *qc);
1da177e4 696 void (*qc_prep) (struct ata_queued_cmd *qc);
9a3d9eb0 697 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
1da177e4 698
e0a71752
TH
699 /* port multiplier */
700 void (*pmp_attach) (struct ata_port *ap);
701 void (*pmp_detach) (struct ata_port *ap);
e0a71752 702
9ec957f2
TH
703 /* Error handlers. ->error_handler overrides ->eng_timeout and
704 * indicates that new-style EH is in place.
705 */
706 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
707
708 void (*freeze) (struct ata_port *ap);
709 void (*thaw) (struct ata_port *ap);
710 void (*error_handler) (struct ata_port *ap);
711 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
1da177e4 712
7d12e780 713 irq_handler_t irq_handler;
1da177e4 714 void (*irq_clear) (struct ata_port *);
83625006 715 u8 (*irq_on) (struct ata_port *);
1da177e4 716
da3dbb17
TH
717 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
718 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
1da177e4 719
500530f6
TH
720 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
721 int (*port_resume) (struct ata_port *ap);
ca77329f
KCA
722 int (*enable_pm) (struct ata_port *ap, enum link_pm policy);
723 void (*disable_pm) (struct ata_port *ap);
1da177e4
LT
724 int (*port_start) (struct ata_port *ap);
725 void (*port_stop) (struct ata_port *ap);
726
cca3974e 727 void (*host_stop) (struct ata_host *host);
1da177e4 728
b73fc89f 729 void (*bmdma_stop) (struct ata_queued_cmd *qc);
1da177e4
LT
730 u8 (*bmdma_status) (struct ata_port *ap);
731};
732
733struct ata_port_info {
d0be4a7d 734 struct scsi_host_template *sht;
cca3974e 735 unsigned long flags;
0c88758b 736 unsigned long link_flags;
1da177e4
LT
737 unsigned long pio_mask;
738 unsigned long mwdma_mask;
739 unsigned long udma_mask;
057ace5e 740 const struct ata_port_operations *port_ops;
21b0ad4f 741 irq_handler_t irq_handler;
e99f8b5e 742 void *private_data;
1da177e4
LT
743};
744
452503f9
AC
745struct ata_timing {
746 unsigned short mode; /* ATA mode */
747 unsigned short setup; /* t1 */
748 unsigned short act8b; /* t2 for 8-bit I/O */
749 unsigned short rec8b; /* t2i for 8-bit I/O */
750 unsigned short cyc8b; /* t0 for 8-bit I/O */
751 unsigned short active; /* t2 or tD */
752 unsigned short recover; /* t2i or tK */
753 unsigned short cycle; /* t0 */
754 unsigned short udma; /* t2CYCTYP/2 */
755};
756
2dcb407e 757#define FIT(v, vmin, vmax) max_t(short, min_t(short, v, vmax), vmin)
1da177e4 758
e9c83914
TH
759extern const unsigned long sata_deb_timing_normal[];
760extern const unsigned long sata_deb_timing_hotplug[];
761extern const unsigned long sata_deb_timing_long[];
762
dd5b06c4 763extern const struct ata_port_operations ata_dummy_port_ops;
21b0ad4f 764extern const struct ata_port_info ata_dummy_port_info;
dd5b06c4 765
e9c83914
TH
766static inline const unsigned long *
767sata_ehc_deb_timing(struct ata_eh_context *ehc)
768{
769 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
770 return sata_deb_timing_hotplug;
771 else
772 return sata_deb_timing_normal;
773}
d7bb4cc7 774
dd5b06c4
TH
775static inline int ata_port_is_dummy(struct ata_port *ap)
776{
777 return ap->ops == &ata_dummy_port_ops;
778}
779
936fd732 780extern void sata_print_link_status(struct ata_link *link);
1da177e4 781extern void ata_port_probe(struct ata_port *);
1da177e4 782extern void ata_bus_reset(struct ata_port *ap);
936fd732
TH
783extern int sata_set_spd(struct ata_link *link);
784extern int sata_link_debounce(struct ata_link *link,
785 const unsigned long *params, unsigned long deadline);
786extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
787 unsigned long deadline);
cc0680a5
TH
788extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
789extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
d4b2bab4 790 unsigned long deadline);
cc0680a5
TH
791extern int sata_link_hardreset(struct ata_link *link,
792 const unsigned long *timing, unsigned long deadline);
793extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
d4b2bab4 794 unsigned long deadline);
cc0680a5 795extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1da177e4
LT
796extern void ata_port_disable(struct ata_port *);
797extern void ata_std_ports(struct ata_ioports *ioaddr);
2855568b 798
f3187195 799extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
f5cda257
TH
800extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
801 const struct ata_port_info * const * ppi, int n_ports);
ecef7253 802extern int ata_host_start(struct ata_host *host);
f3187195
TH
803extern int ata_host_register(struct ata_host *host,
804 struct scsi_host_template *sht);
f5cda257
TH
805extern int ata_host_activate(struct ata_host *host, int irq,
806 irq_handler_t irq_handler, unsigned long irq_flags,
807 struct scsi_host_template *sht);
0529c159 808extern void ata_host_detach(struct ata_host *host);
cca3974e
JG
809extern void ata_host_init(struct ata_host *, struct device *,
810 unsigned long, const struct ata_port_operations *);
193515d5 811extern int ata_scsi_detect(struct scsi_host_template *sht);
1da177e4
LT
812extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
813extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
80289167 814extern void ata_sas_port_destroy(struct ata_port *);
cca3974e 815extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
80289167
BK
816 struct ata_port_info *, struct Scsi_Host *);
817extern int ata_sas_port_init(struct ata_port *);
818extern int ata_sas_port_start(struct ata_port *ap);
819extern void ata_sas_port_stop(struct ata_port *ap);
820extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
821extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
822 struct ata_port *ap);
1da177e4 823extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
936fd732
TH
824extern int sata_scr_valid(struct ata_link *link);
825extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
826extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
827extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
828extern int ata_link_online(struct ata_link *link);
829extern int ata_link_offline(struct ata_link *link);
6ffa01d8 830#ifdef CONFIG_PM
cca3974e
JG
831extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
832extern void ata_host_resume(struct ata_host *host);
6ffa01d8 833#endif
67846b30 834extern int ata_ratelimit(void);
d1adc1bb
TH
835extern int ata_busy_sleep(struct ata_port *ap,
836 unsigned long timeout_pat, unsigned long timeout);
88ff6eaf 837extern void ata_wait_after_reset(struct ata_port *ap, unsigned long deadline);
d4b2bab4 838extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
c22daff4
TH
839extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
840 unsigned long interval_msec,
841 unsigned long timeout_msec);
3f19859e
TH
842extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
843 u8 *r_err);
67846b30 844
1da177e4
LT
845/*
846 * Default driver ops implementations
847 */
057ace5e 848extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4 849extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
436d34b3 850extern int atapi_cmd_type(u8 opcode);
9977126c
TH
851extern void ata_tf_to_fis(const struct ata_taskfile *tf,
852 u8 pmp, int is_cmd, u8 *fis);
057ace5e 853extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
7dc951ae
TH
854extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
855 unsigned long mwdma_mask, unsigned long udma_mask);
856extern void ata_unpack_xfermask(unsigned long xfer_mask,
857 unsigned long *pio_mask, unsigned long *mwdma_mask,
858 unsigned long *udma_mask);
859extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
860extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
861extern int ata_xfer_mode2shift(unsigned long xfer_mode);
862extern const char *ata_mode_string(unsigned long xfer_mask);
863extern unsigned long ata_id_xfermask(const u16 *id);
2dcb407e
JG
864extern void ata_noop_dev_select(struct ata_port *ap, unsigned int device);
865extern void ata_std_dev_select(struct ata_port *ap, unsigned int device);
1da177e4
LT
866extern u8 ata_check_status(struct ata_port *ap);
867extern u8 ata_altstatus(struct ata_port *ap);
057ace5e 868extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
2dcb407e
JG
869extern int ata_port_start(struct ata_port *ap);
870extern int ata_sff_port_start(struct ata_port *ap);
871extern irqreturn_t ata_interrupt(int irq, void *dev_instance);
55dba312
TH
872extern unsigned int ata_data_xfer(struct ata_device *dev,
873 unsigned char *buf, unsigned int buflen, int rw);
874extern unsigned int ata_data_xfer_noirq(struct ata_device *dev,
875 unsigned char *buf, unsigned int buflen, int rw);
31cc23b3 876extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
d26fc955 877extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
1da177e4 878extern void ata_qc_prep(struct ata_queued_cmd *qc);
e46834cd 879extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
9a3d9eb0 880extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
1da177e4
LT
881extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
882 unsigned int n_elem);
057ace5e 883extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
10305f0f 884extern void ata_dev_disable(struct ata_device *adev);
6a62a04d
TH
885extern void ata_id_string(const u16 *id, unsigned char *s,
886 unsigned int ofs, unsigned int len);
887extern void ata_id_c_string(const u16 *id, unsigned char *s,
888 unsigned int ofs, unsigned int len);
2dcb407e
JG
889extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
890extern void ata_bmdma_start(struct ata_queued_cmd *qc);
b73fc89f 891extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1da177e4
LT
892extern u8 ata_bmdma_status(struct ata_port *ap);
893extern void ata_bmdma_irq_clear(struct ata_port *ap);
6d97dbd7
TH
894extern void ata_bmdma_freeze(struct ata_port *ap);
895extern void ata_bmdma_thaw(struct ata_port *ap);
f5914a46 896extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
6d97dbd7
TH
897 ata_reset_fn_t softreset,
898 ata_reset_fn_t hardreset,
899 ata_postreset_fn_t postreset);
900extern void ata_bmdma_error_handler(struct ata_port *ap);
901extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
9a1004d0
TH
902extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
903 u8 status, int in_wq);
f686bcb8 904extern void ata_qc_complete(struct ata_queued_cmd *qc);
dedaf2b0
TH
905extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
906 void (*finish_qc)(struct ata_queued_cmd *));
3373efd8 907extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1da177e4
LT
908 void (*done)(struct scsi_cmnd *));
909extern int ata_std_bios_param(struct scsi_device *sdev,
910 struct block_device *bdev,
911 sector_t capacity, int geom[]);
912extern int ata_scsi_slave_config(struct scsi_device *sdev);
83c47bcb 913extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
a6e6ce8e
TH
914extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
915 int queue_depth);
3373efd8 916extern struct ata_device *ata_dev_pair(struct ata_device *adev);
0260731f 917extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
83625006 918extern u8 ata_irq_on(struct ata_port *ap);
1da177e4 919
be0d18df
AC
920extern int ata_cable_40wire(struct ata_port *ap);
921extern int ata_cable_80wire(struct ata_port *ap);
922extern int ata_cable_sata(struct ata_port *ap);
c88f90c3 923extern int ata_cable_ignore(struct ata_port *ap);
be0d18df
AC
924extern int ata_cable_unknown(struct ata_port *ap);
925
452503f9
AC
926/*
927 * Timing helpers
928 */
1bc4ccff
AC
929
930extern unsigned int ata_pio_need_iordy(const struct ata_device *);
6357357c 931extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
452503f9
AC
932extern int ata_timing_compute(struct ata_device *, unsigned short,
933 struct ata_timing *, int, int);
934extern void ata_timing_merge(const struct ata_timing *,
935 const struct ata_timing *, struct ata_timing *,
936 unsigned int);
a0f79b92 937extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
452503f9
AC
938
939enum {
940 ATA_TIMING_SETUP = (1 << 0),
941 ATA_TIMING_ACT8B = (1 << 1),
942 ATA_TIMING_REC8B = (1 << 2),
943 ATA_TIMING_CYC8B = (1 << 3),
944 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
945 ATA_TIMING_CYC8B,
946 ATA_TIMING_ACTIVE = (1 << 4),
947 ATA_TIMING_RECOVER = (1 << 5),
948 ATA_TIMING_CYCLE = (1 << 6),
949 ATA_TIMING_UDMA = (1 << 7),
950 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
951 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
952 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
953 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
954};
955
e1ddb4b6
AC
956/* libata-acpi.c */
957#ifdef CONFIG_ATA_ACPI
c05e6ff0
TH
958static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
959{
960 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
961 return &ap->__acpi_init_gtm;
962 return NULL;
963}
0d02f0b2
TH
964int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
965int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
7c77fa4d
TH
966unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
967 const struct ata_acpi_gtm *gtm);
021ee9a6 968int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
e1ddb4b6 969#else
c05e6ff0
TH
970static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
971{
972 return NULL;
973}
7c77fa4d
TH
974
975static inline int ata_acpi_stm(const struct ata_port *ap,
976 struct ata_acpi_gtm *stm)
977{
978 return -ENOSYS;
979}
980
981static inline int ata_acpi_gtm(const struct ata_port *ap,
982 struct ata_acpi_gtm *stm)
983{
984 return -ENOSYS;
985}
986
987static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
988 const struct ata_acpi_gtm *gtm)
989{
990 return 0;
991}
021ee9a6
TH
992
993static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
994 const struct ata_acpi_gtm *gtm)
995{
996 return 0;
997}
e1ddb4b6 998#endif
1da177e4
LT
999
1000#ifdef CONFIG_PCI
2855568b
JG
1001struct pci_dev;
1002
2dcb407e 1003extern int ata_pci_init_one(struct pci_dev *pdev,
2855568b 1004 const struct ata_port_info * const * ppi);
2dcb407e 1005extern void ata_pci_remove_one(struct pci_dev *pdev);
2855568b
JG
1006#ifdef CONFIG_PM
1007extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1008extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1009extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1010extern int ata_pci_device_resume(struct pci_dev *pdev);
1011#endif
1012extern int ata_pci_clear_simplex(struct pci_dev *pdev);
1013
1da177e4
LT
1014struct pci_bits {
1015 unsigned int reg; /* PCI config register to read */
1016 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1017 unsigned long mask;
1018 unsigned long val;
1019};
1020
d583bc18 1021extern int ata_pci_init_sff_host(struct ata_host *host);
1626aeb8 1022extern int ata_pci_init_bmdma(struct ata_host *host);
d583bc18
TH
1023extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
1024 const struct ata_port_info * const * ppi,
1025 struct ata_host **r_host);
4e6b79fa
TH
1026extern int ata_pci_activate_sff_host(struct ata_host *host,
1027 irq_handler_t irq_handler,
1028 struct scsi_host_template *sht);
057ace5e 1029extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
7dc951ae
TH
1030extern unsigned long ata_pci_default_filter(struct ata_device *dev,
1031 unsigned long xfer_mask);
1da177e4
LT
1032#endif /* CONFIG_PCI */
1033
3af9a77a
TH
1034/*
1035 * PMP
1036 */
31f88384 1037extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
3af9a77a
TH
1038extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline);
1039extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class,
1040 unsigned long deadline);
1041extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class);
1042extern void sata_pmp_do_eh(struct ata_port *ap,
1043 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
1044 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset,
1045 ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset,
1046 ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset);
1047
ece1d636
TH
1048/*
1049 * EH
1050 */
7b70fc03 1051extern void ata_port_schedule_eh(struct ata_port *ap);
dbd82616 1052extern int ata_link_abort(struct ata_link *link);
7b70fc03 1053extern int ata_port_abort(struct ata_port *ap);
e3180499 1054extern int ata_port_freeze(struct ata_port *ap);
7d77b247 1055extern int sata_async_notification(struct ata_port *ap);
e3180499
TH
1056
1057extern void ata_eh_freeze_port(struct ata_port *ap);
1058extern void ata_eh_thaw_port(struct ata_port *ap);
7b70fc03 1059
ece1d636
TH
1060extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1061extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1062
f5914a46
TH
1063extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1064 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1065 ata_postreset_fn_t postreset);
022bdb07 1066
61440db6
TH
1067/*
1068 * printk helpers
1069 */
1070#define ata_port_printk(ap, lv, fmt, args...) \
c2e366a1 1071 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
61440db6 1072
8989805d
TH
1073#define ata_link_printk(link, lv, fmt, args...) do { \
1074 if ((link)->ap->nr_pmp_links) \
c2e366a1 1075 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
8989805d
TH
1076 (link)->pmp , ##args); \
1077 else \
c2e366a1 1078 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
8989805d 1079 } while(0)
9af5c9c9 1080
61440db6 1081#define ata_dev_printk(dev, lv, fmt, args...) \
c2e366a1 1082 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
8989805d 1083 (dev)->link->pmp + (dev)->devno , ##args)
1da177e4 1084
f3e81b19
TH
1085/*
1086 * ata_eh_info helpers
1087 */
cb94c1cf
TH
1088extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1089 __attribute__ ((format (printf, 2, 3)));
1090extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1091 __attribute__ ((format (printf, 2, 3)));
b64bbc39 1092extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
f3e81b19 1093
f8f1e1cc 1094static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
084fe639 1095{
cf480626 1096 ehi->action |= ATA_EH_RESET;
084fe639
TH
1097 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1098}
1099
c0b6c037
TH
1100static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1101{
f8f1e1cc
TH
1102 ata_ehi_schedule_probe(ehi);
1103 ehi->flags |= ATA_EHI_HOTPLUGGED;
f9df58cb 1104 ehi->action |= ATA_EH_ENABLE_LINK;
c0b6c037
TH
1105 ehi->err_mask |= AC_ERR_ATA_BUS;
1106}
1107
cbcdd875
TH
1108/*
1109 * port description helpers
1110 */
1111extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1112 __attribute__ ((format (printf, 2, 3)));
1113#ifdef CONFIG_PCI
1114extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1115 const char *name);
1116#endif
1117
1da177e4
LT
1118static inline unsigned int ata_tag_valid(unsigned int tag)
1119{
1120 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1121}
1122
2ab7db1f
TH
1123static inline unsigned int ata_tag_internal(unsigned int tag)
1124{
1125 return tag == ATA_MAX_QUEUE - 1;
1126}
1127
5806db22
TH
1128/*
1129 * device helpers
1130 */
e1211e3f 1131static inline unsigned int ata_class_enabled(unsigned int class)
597afd21 1132{
e0a71752
TH
1133 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1134 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
597afd21
TH
1135}
1136
e1211e3f 1137static inline unsigned int ata_class_disabled(unsigned int class)
1da177e4 1138{
e0a71752
TH
1139 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1140 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
e1211e3f
TH
1141}
1142
002c8054
TH
1143static inline unsigned int ata_class_absent(unsigned int class)
1144{
1145 return !ata_class_enabled(class) && !ata_class_disabled(class);
1146}
1147
e1211e3f
TH
1148static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1149{
1150 return ata_class_enabled(dev->class);
1151}
1152
1153static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1154{
1155 return ata_class_disabled(dev->class);
1da177e4
LT
1156}
1157
002c8054
TH
1158static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1159{
1160 return ata_class_absent(dev->class);
1161}
1162
5806db22 1163/*
f58229f8 1164 * link helpers
5806db22 1165 */
8989805d
TH
1166static inline int ata_is_host_link(const struct ata_link *link)
1167{
1168 return link == &link->ap->link;
1169}
1170
f58229f8 1171static inline int ata_link_max_devices(const struct ata_link *link)
5806db22 1172{
8989805d 1173 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
5806db22
TH
1174 return 2;
1175 return 1;
1176}
1177
da917d69
TH
1178static inline int ata_link_active(struct ata_link *link)
1179{
1180 return ata_tag_valid(link->active_tag) || link->sactive;
1181}
1182
8989805d
TH
1183static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1184{
1185 if (ap->nr_pmp_links)
1186 return ap->pmp_link;
1187 return &ap->link;
1188}
1189
1190static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1191{
1192 struct ata_port *ap = link->ap;
1193
1194 if (link == &ap->link) {
1195 if (!ap->nr_pmp_links)
1196 return NULL;
1197 return ap->pmp_link;
1198 }
1199
5d44b414 1200 if (++link < ap->nr_pmp_links + ap->pmp_link)
8989805d
TH
1201 return link;
1202 return NULL;
1203}
1204
1205#define __ata_port_for_each_link(lk, ap) \
1206 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1207
1208#define ata_port_for_each_link(link, ap) \
1209 for ((link) = ata_port_first_link(ap); (link); \
1210 (link) = ata_port_next_link(link))
f58229f8
TH
1211
1212#define ata_link_for_each_dev(dev, link) \
1213 for ((dev) = (link)->device; \
1214 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1215 (dev)++)
1216
1217#define ata_link_for_each_dev_reverse(dev, link) \
1218 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1219 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
5806db22 1220
1da177e4
LT
1221static inline u8 ata_chk_status(struct ata_port *ap)
1222{
1223 return ap->ops->check_status(ap);
1224}
1225
6d1245bf
TH
1226/**
1227 * ata_ncq_enabled - Test whether NCQ is enabled
1228 * @dev: ATA device to test for
1229 *
1230 * LOCKING:
1231 * spin_lock_irqsave(host lock)
1232 *
1233 * RETURNS:
1234 * 1 if NCQ is enabled for @dev, 0 otherwise.
1235 */
1236static inline int ata_ncq_enabled(struct ata_device *dev)
1237{
1238 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1239 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1240}
0baab86b
EF
1241
1242/**
1243 * ata_pause - Flush writes and pause 400 nanoseconds.
1244 * @ap: Port to wait for.
1245 *
1246 * LOCKING:
1247 * Inherited from caller.
1248 */
1249
1da177e4
LT
1250static inline void ata_pause(struct ata_port *ap)
1251{
1252 ata_altstatus(ap);
1253 ndelay(400);
1254}
1255
0baab86b
EF
1256
1257/**
1258 * ata_busy_wait - Wait for a port status register
1259 * @ap: Port to wait for.
0777721c
AC
1260 * @bits: bits that must be clear
1261 * @max: number of 10uS waits to perform
0baab86b
EF
1262 *
1263 * Waits up to max*10 microseconds for the selected bits in the port's
1264 * status register to be cleared.
1265 * Returns final value of status register.
1266 *
1267 * LOCKING:
1268 * Inherited from caller.
1269 */
1270
1da177e4
LT
1271static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1272 unsigned int max)
1273{
1274 u8 status;
1275
1276 do {
1277 udelay(10);
1278 status = ata_chk_status(ap);
1279 max--;
d1adc1bb 1280 } while (status != 0xff && (status & bits) && (max > 0));
1da177e4
LT
1281
1282 return status;
1283}
1284
0baab86b
EF
1285
1286/**
1287 * ata_wait_idle - Wait for a port to be idle.
1288 * @ap: Port to wait for.
1289 *
1290 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1291 * Returns final value of status register.
1292 *
1293 * LOCKING:
1294 * Inherited from caller.
1295 */
1296
1da177e4
LT
1297static inline u8 ata_wait_idle(struct ata_port *ap)
1298{
1299 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1300
15529456 1301#ifdef ATA_DEBUG
55f3952d 1302 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
15529456
TH
1303 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1304 status);
1305#endif
1da177e4
LT
1306
1307 return status;
1308}
1309
1310static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1311{
1312 qc->tf.ctl |= ATA_NIEN;
1313}
1314
f69499f4
TH
1315static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1316 unsigned int tag)
1da177e4
LT
1317{
1318 if (likely(ata_tag_valid(tag)))
1319 return &ap->qcmd[tag];
1320 return NULL;
1321}
1322
f69499f4
TH
1323static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1324 unsigned int tag)
1325{
1326 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1327
1328 if (unlikely(!qc) || !ap->ops->error_handler)
1329 return qc;
1330
1331 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1332 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1333 return qc;
1334
1335 return NULL;
1336}
1337
aacda375
TH
1338static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1339{
1340 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1341}
1342
3373efd8 1343static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1da177e4
LT
1344{
1345 memset(tf, 0, sizeof(*tf));
1346
9af5c9c9 1347 tf->ctl = dev->link->ap->ctl;
3373efd8 1348 if (dev->devno == 0)
1da177e4
LT
1349 tf->device = ATA_DEVICE_OBS;
1350 else
1351 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1352}
1353
2c13b7ce
JG
1354static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1355{
501e0c50 1356 qc->dma_dir = DMA_NONE;
ff2aeb1e 1357 qc->sg = NULL;
2c13b7ce 1358 qc->flags = 0;
87260216
JA
1359 qc->cursg = NULL;
1360 qc->cursg_ofs = 0;
aacda375 1361 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
7a801184 1362 qc->n_elem = 0;
a22e2eb0 1363 qc->err_mask = 0;
5a5dbd18 1364 qc->sect_size = ATA_SECT_SIZE;
2c13b7ce 1365
3373efd8 1366 ata_tf_init(qc->dev, &qc->tf);
e61e0672
TH
1367
1368 /* init result_tf such that it indicates normal completion */
1369 qc->result_tf.command = ATA_DRDY;
1370 qc->result_tf.feature = 0;
2c13b7ce
JG
1371}
1372
057ace5e 1373static inline int ata_try_flush_cache(const struct ata_device *dev)
1da177e4
LT
1374{
1375 return ata_id_wcache_enabled(dev->id) ||
1376 ata_id_has_flush(dev->id) ||
1377 ata_id_has_flush_ext(dev->id);
1378}
1379
a7dac447
JG
1380static inline unsigned int ac_err_mask(u8 status)
1381{
3655d1d3 1382 if (status & (ATA_BUSY | ATA_DRQ))
11a56d24 1383 return AC_ERR_HSM;
a7dac447
JG
1384 if (status & (ATA_ERR | ATA_DF))
1385 return AC_ERR_DEV;
1386 return 0;
1387}
1388
1389static inline unsigned int __ac_err_mask(u8 status)
1390{
1391 unsigned int mask = ac_err_mask(status);
1392 if (mask == 0)
1393 return AC_ERR_OTHER;
1394 return mask;
1395}
1396
35bb94b1
JG
1397static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1398{
4911487a 1399 return *(struct ata_port **)&host->hostdata[0];
35bb94b1
JG
1400}
1401
1da177e4 1402#endif /* __LINUX_LIBATA_H__ */