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