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