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