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