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