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