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