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