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