projects / GitHub / LineageOS / android_kernel_samsung_universal7580.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
pata_cmd64x: Set up MWDMA modes properly
[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 */
ea1dd4e1 142 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
949b38af 143
e5c9e081 144 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
3343571d 145 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
13b8d09f 146 ATA_DFLAG_SPUNDOWN = (1 << 10), /* XXX: for spindown_compat */
72fa4b74 147 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
1da177e4 148
abdda733
TH		 149 ATA_DFLAG_DETACH = (1 << 16),
150 ATA_DFLAG_DETACHED = (1 << 17),
151
1da177e4
LT		 152 ATA_DEV_UNKNOWN = 0, /* unknown device */
153 ATA_DEV_ATA = 1, /* ATA device */
154 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
155 ATA_DEV_ATAPI = 3, /* ATAPI device */
156 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
157 ATA_DEV_NONE = 5, /* no device */
158
0c88758b
TH		 159 /* struct ata_link flags */
160 ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */
161 ATA_LFLAG_SKIP_D2H_BSY = (1 << 1), /* can't wait for the first D2H
162 * Register FIS clearing BSY */
163
1da177e4 164 /* struct ata_port flags */
949b38af 165 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
1da177e4 166 /* (doesn't imply presence) */
949b38af
TH		 167 ATA_FLAG_SATA = (1 << 1),
168 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
169 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
170 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
171 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
172 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
173 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
174 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
7395acb2
TH		 175 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
176 * doesn't handle PIO interrupts */
177 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
7395acb2 178 ATA_FLAG_DEBUGMSG = (1 << 13),
b2a8bbe6 179 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
f834e49f 180 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
3cadbcc0 181 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
949b38af 182
b51e9e5d
TH		 183 /* The following flag belongs to ap->pflags but is kept in
184 * ap->flags because it's referenced in many LLDs and will be
185 * removed in not-too-distant future.
186 */
187 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
188
189 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
9ec957f2 190
b51e9e5d
TH		 191 /* struct ata_port pflags */
192 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
193 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
194 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
195 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
196 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
197 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
198 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
f4d6d004 199 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
949b38af 200
b51e9e5d 201 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
500530f6 202 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
64578a3d 203 ATA_PFLAG_GTM_VALID = (1 << 19), /* acpi_gtm data valid */
949b38af
TH		 204
205 /* struct ata_queued_cmd flags */
206 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
207 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
208 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
1da177e4 209 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
27197367 210 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
e61e0672
TH		 211 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
212
9ec957f2
TH		 213 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
214 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
215 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
1da177e4 216
4e5ec5db 217 /* host set flags */
cca3974e 218 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
ecef7253 219 ATA_HOST_STARTED = (1 << 1), /* Host started */
9bec2e38 220
b8b275ef
TH		 221 /* bits 24:31 of host->flags are reserved for LLD specific flags */
222
1da177e4 223 /* various lengths of time */
8d238e01
AC		 224 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
225 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
a2a7a662
TH		 226 ATA_TMOUT_INTERNAL = 30 * HZ,
227 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
1da177e4
LT		 228
229 /* ATA bus states */
230 BUS_UNKNOWN = 0,
231 BUS_DMA = 1,
232 BUS_IDLE = 2,
233 BUS_NOINTR = 3,
234 BUS_NODATA = 4,
235 BUS_TIMER = 5,
236 BUS_PIO = 6,
237 BUS_EDD = 7,
238 BUS_IDENTIFY = 8,
239 BUS_PACKET = 9,
240
241 /* SATA port states */
242 PORT_UNKNOWN = 0,
243 PORT_ENABLED = 1,
244 PORT_DISABLED = 2,
245
246 /* encoding various smaller bitmaps into a single
1da7b0d0 247 * unsigned int bitmap
1da177e4 248 */
b352e57d
AC		 249 ATA_BITS_PIO = 7,
250 ATA_BITS_MWDMA = 5,
1da7b0d0
TH		 251 ATA_BITS_UDMA = 8,
252
253 ATA_SHIFT_PIO = 0,
254 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
255 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
256
257 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
258 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
259 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
cedc9a47
JG		 260
261 /* size of buffer to pad xfers ending on unaligned boundaries */
262 ATA_DMA_PAD_SZ = 4,
263 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
949b38af 264
0c247c55
TH		 265 /* ering size */
266 ATA_ERING_SIZE = 32,
267
f3e81b19
TH		 268 /* desc_len for ata_eh_info and context */
269 ATA_EH_DESC_LEN = 80,
270
9be1e979
TH		 271 /* reset / recovery action types */
272 ATA_EH_REVALIDATE = (1 << 0),
273 ATA_EH_SOFTRESET = (1 << 1),
274 ATA_EH_HARDRESET = (1 << 2),
275
276 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
9666f400 277 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
9be1e979 278
f3e81b19 279 /* ata_eh_info->flags */
abdda733 280 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
13abf50d 281 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
1cdaf534
TH		 282 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
283 ATA_EHI_QUIET = (1 << 3), /* be quiet */
abdda733 284
0d64a233
TH		 285 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
286 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
287 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
288 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
289 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
f3e81b19 290
0d64a233 291 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
13abf50d
TH		 292 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
293
ad9e2762
TH		 294 /* max repeat if error condition is still set after ->error_handler */
295 ATA_EH_MAX_REPEAT = 5,
296
14d2bac1
TH		 297 /* how hard are we gonna try to probe/recover devices */
298 ATA_PROBE_MAX_TRIES = 3,
022bdb07 299 ATA_EH_DEV_TRIES = 3,
f5914a46 300
93590859
AC		 301 /* Horkage types. May be set by libata or controller on drives
302 (some horkage may be drive/controller pair dependant */
303
304 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
6919a0a6
AC		 305 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
306 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
18d6e9d5 307 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
16c55b03 308 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
1da177e4
LT		 309};
310
14be71f4 311enum hsm_task_states {
c56b14d2 312 HSM_ST_IDLE, /* no command on going */
71527647
AL		 313 HSM_ST_FIRST, /* (waiting the device to)
314 write CDB or first data block */
c56b14d2
AL		 315 HSM_ST, /* (waiting the device to) transfer data */
316 HSM_ST_LAST, /* (waiting the device to) complete command */
c56b14d2 317 HSM_ST_ERR, /* error */
1da177e4
LT		 318};
319
a7dac447 320enum ata_completion_errors {
11a56d24
TH		 321 AC_ERR_DEV = (1 << 0), /* device reported error */
322 AC_ERR_HSM = (1 << 1), /* host state machine violation */
323 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
324 AC_ERR_MEDIA = (1 << 3), /* media error */
325 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
326 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
327 AC_ERR_SYSTEM = (1 << 6), /* system error */
328 AC_ERR_INVALID = (1 << 7), /* invalid argument */
329 AC_ERR_OTHER = (1 << 8), /* unknown */
55a8e2c8 330 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
5335b729 331 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
a7dac447
JG		 332};
333
1da177e4
LT		 334/* forward declarations */
335struct scsi_device;
336struct ata_port_operations;
337struct ata_port;
cc0680a5 338struct ata_link;
1da177e4
LT		 339struct ata_queued_cmd;
340
341/* typedefs */
77853bf2 342typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
cc0680a5
TH		 343typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
344typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
d4b2bab4 345 unsigned long deadline);
cc0680a5 346typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
1da177e4
LT		 347
348struct ata_ioports {
0d5ff566
TH		 349 void __iomem *cmd_addr;
350 void __iomem *data_addr;
351 void __iomem *error_addr;
352 void __iomem *feature_addr;
353 void __iomem *nsect_addr;
354 void __iomem *lbal_addr;
355 void __iomem *lbam_addr;
356 void __iomem *lbah_addr;
357 void __iomem *device_addr;
358 void __iomem *status_addr;
359 void __iomem *command_addr;
360 void __iomem *altstatus_addr;
361 void __iomem *ctl_addr;
362 void __iomem *bmdma_addr;
363 void __iomem *scr_addr;
1da177e4
LT		 364};
365
cca3974e 366struct ata_host {
1da177e4
LT		 367 spinlock_t lock;
368 struct device *dev;
369 unsigned long irq;
2ec7df04 370 unsigned long irq2;
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;
bfd60579 584
500530f6
TH		 585 pm_message_t pm_mesg;
586 int *pm_result;
587
5ddf24c5
TH		 588 struct timer_list fastdrain_timer;
589 unsigned long fastdrain_cnt;
590
1da177e4 591 void *private_data;
fe635c7e 592
fafbae87
TH		 593#ifdef CONFIG_ATA_ACPI
594 acpi_handle acpi_handle;
64578a3d 595 struct ata_acpi_gtm acpi_gtm;
fafbae87 596#endif
fe635c7e 597 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
1da177e4
LT		 598};
599
600struct ata_port_operations {
601 void (*port_disable) (struct ata_port *);
602
cd0d3bbc 603 void (*dev_config) (struct ata_device *);
1da177e4
LT		 604
605 void (*set_piomode) (struct ata_port *, struct ata_device *);
606 void (*set_dmamode) (struct ata_port *, struct ata_device *);
a76b62ca 607 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
1da177e4 608
057ace5e 609 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 610 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
611
057ace5e 612 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4
LT		 613 u8 (*check_status)(struct ata_port *ap);
614 u8 (*check_altstatus)(struct ata_port *ap);
1da177e4
LT		 615 void (*dev_select)(struct ata_port *ap, unsigned int device);
616
c19ba8af 617 void (*phy_reset) (struct ata_port *ap); /* obsolete */
0260731f 618 int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
c19ba8af 619
be0d18df
AC		 620 int (*cable_detect) (struct ata_port *ap);
621
b229a7b0 622 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
1da177e4
LT		 623
624 void (*bmdma_setup) (struct ata_queued_cmd *qc);
625 void (*bmdma_start) (struct ata_queued_cmd *qc);
626
a6b2c5d4
AC		 627 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
628
1da177e4 629 void (*qc_prep) (struct ata_queued_cmd *qc);
9a3d9eb0 630 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
1da177e4 631
9ec957f2
TH		 632 /* Error handlers. ->error_handler overrides ->eng_timeout and
633 * indicates that new-style EH is in place.
634 */
635 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
636
637 void (*freeze) (struct ata_port *ap);
638 void (*thaw) (struct ata_port *ap);
639 void (*error_handler) (struct ata_port *ap);
640 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
1da177e4 641
7d12e780 642 irq_handler_t irq_handler;
1da177e4 643 void (*irq_clear) (struct ata_port *);
83625006
AI		 644 u8 (*irq_on) (struct ata_port *);
645 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
1da177e4 646
da3dbb17
TH		 647 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
648 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
1da177e4 649
500530f6
TH		 650 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
651 int (*port_resume) (struct ata_port *ap);
652
1da177e4
LT		 653 int (*port_start) (struct ata_port *ap);
654 void (*port_stop) (struct ata_port *ap);
655
cca3974e 656 void (*host_stop) (struct ata_host *host);
1da177e4 657
b73fc89f 658 void (*bmdma_stop) (struct ata_queued_cmd *qc);
1da177e4
LT		 659 u8 (*bmdma_status) (struct ata_port *ap);
660};
661
662struct ata_port_info {
d0be4a7d 663 struct scsi_host_template *sht;
cca3974e 664 unsigned long flags;
0c88758b 665 unsigned long link_flags;
1da177e4
LT		 666 unsigned long pio_mask;
667 unsigned long mwdma_mask;
668 unsigned long udma_mask;
057ace5e 669 const struct ata_port_operations *port_ops;
21b0ad4f 670 irq_handler_t irq_handler;
e99f8b5e 671 void *private_data;
1da177e4
LT		 672};
673
452503f9
AC		 674struct ata_timing {
675 unsigned short mode; /* ATA mode */
676 unsigned short setup; /* t1 */
677 unsigned short act8b; /* t2 for 8-bit I/O */
678 unsigned short rec8b; /* t2i for 8-bit I/O */
679 unsigned short cyc8b; /* t0 for 8-bit I/O */
680 unsigned short active; /* t2 or tD */
681 unsigned short recover; /* t2i or tK */
682 unsigned short cycle; /* t0 */
683 unsigned short udma; /* t2CYCTYP/2 */
684};
685
686#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
1da177e4 687
e9c83914
TH		 688extern const unsigned long sata_deb_timing_normal[];
689extern const unsigned long sata_deb_timing_hotplug[];
690extern const unsigned long sata_deb_timing_long[];
691
dd5b06c4 692extern const struct ata_port_operations ata_dummy_port_ops;
21b0ad4f 693extern const struct ata_port_info ata_dummy_port_info;
dd5b06c4 694
e9c83914
TH		 695static inline const unsigned long *
696sata_ehc_deb_timing(struct ata_eh_context *ehc)
697{
698 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
699 return sata_deb_timing_hotplug;
700 else
701 return sata_deb_timing_normal;
702}
d7bb4cc7 703
dd5b06c4
TH		 704static inline int ata_port_is_dummy(struct ata_port *ap)
705{
706 return ap->ops == &ata_dummy_port_ops;
707}
708
936fd732 709extern void sata_print_link_status(struct ata_link *link);
1da177e4
LT		 710extern void ata_port_probe(struct ata_port *);
711extern void __sata_phy_reset(struct ata_port *ap);
712extern void sata_phy_reset(struct ata_port *ap);
713extern void ata_bus_reset(struct ata_port *ap);
936fd732
TH		 714extern int sata_set_spd(struct ata_link *link);
715extern int sata_link_debounce(struct ata_link *link,
716 const unsigned long *params, unsigned long deadline);
717extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
718 unsigned long deadline);
cc0680a5
TH		 719extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
720extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
d4b2bab4 721 unsigned long deadline);
cc0680a5
TH		 722extern int sata_link_hardreset(struct ata_link *link,
723 const unsigned long *timing, unsigned long deadline);
724extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
d4b2bab4 725 unsigned long deadline);
cc0680a5 726extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1da177e4
LT		 727extern void ata_port_disable(struct ata_port *);
728extern void ata_std_ports(struct ata_ioports *ioaddr);
729#ifdef CONFIG_PCI
1626aeb8
TH		 730extern int ata_pci_init_one (struct pci_dev *pdev,
731 const struct ata_port_info * const * ppi);
1da177e4 732extern void ata_pci_remove_one (struct pci_dev *pdev);
6ffa01d8 733#ifdef CONFIG_PM
3c5100c1 734extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
553c4aa6 735extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
3c5100c1 736extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
9b847548 737extern int ata_pci_device_resume(struct pci_dev *pdev);
6ffa01d8 738#endif
17bb34a3 739extern int ata_pci_clear_simplex(struct pci_dev *pdev);
1da177e4 740#endif /* CONFIG_PCI */
f3187195 741extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
f5cda257
TH		 742extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
743 const struct ata_port_info * const * ppi, int n_ports);
ecef7253 744extern int ata_host_start(struct ata_host *host);
f3187195
TH		 745extern int ata_host_register(struct ata_host *host,
746 struct scsi_host_template *sht);
f5cda257
TH		 747extern int ata_host_activate(struct ata_host *host, int irq,
748 irq_handler_t irq_handler, unsigned long irq_flags,
749 struct scsi_host_template *sht);
0529c159 750extern void ata_host_detach(struct ata_host *host);
cca3974e
JG		 751extern void ata_host_init(struct ata_host *, struct device *,
752 unsigned long, const struct ata_port_operations *);
193515d5 753extern int ata_scsi_detect(struct scsi_host_template *sht);
1da177e4
LT		 754extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
755extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
80289167 756extern void ata_sas_port_destroy(struct ata_port *);
cca3974e 757extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
80289167
BK		 758 struct ata_port_info *, struct Scsi_Host *);
759extern int ata_sas_port_init(struct ata_port *);
760extern int ata_sas_port_start(struct ata_port *ap);
761extern void ata_sas_port_stop(struct ata_port *ap);
762extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
763extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
764 struct ata_port *ap);
1da177e4 765extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
936fd732
TH		 766extern int sata_scr_valid(struct ata_link *link);
767extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
768extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
769extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
770extern int ata_link_online(struct ata_link *link);
771extern int ata_link_offline(struct ata_link *link);
6ffa01d8 772#ifdef CONFIG_PM
cca3974e
JG		 773extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
774extern void ata_host_resume(struct ata_host *host);
6ffa01d8 775#endif
67846b30 776extern int ata_ratelimit(void);
d1adc1bb
TH		 777extern int ata_busy_sleep(struct ata_port *ap,
778 unsigned long timeout_pat, unsigned long timeout);
d4b2bab4 779extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
65f27f38 780extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
86e45b6b 781 void *data, unsigned long delay);
c22daff4
TH		 782extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
783 unsigned long interval_msec,
784 unsigned long timeout_msec);
a619f981 785extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
67846b30 786
1da177e4
LT		 787/*
788 * Default driver ops implementations
789 */
057ace5e 790extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4 791extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
9977126c
TH		 792extern void ata_tf_to_fis(const struct ata_taskfile *tf,
793 u8 pmp, int is_cmd, u8 *fis);
057ace5e 794extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1da177e4
LT		 795extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
796extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
797extern u8 ata_check_status(struct ata_port *ap);
798extern u8 ata_altstatus(struct ata_port *ap);
057ace5e 799extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
1da177e4 800extern int ata_port_start (struct ata_port *ap);
d92e74d3 801extern int ata_sff_port_start (struct ata_port *ap);
7d12e780 802extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
0d5ff566
TH		 803extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
804 unsigned int buflen, int write_data);
805extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
806 unsigned int buflen, int write_data);
d26fc955 807extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
1da177e4 808extern void ata_qc_prep(struct ata_queued_cmd *qc);
e46834cd 809extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
9a3d9eb0 810extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
1da177e4
LT		 811extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
812 unsigned int buflen);
813extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
814 unsigned int n_elem);
057ace5e 815extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
10305f0f 816extern void ata_dev_disable(struct ata_device *adev);
6a62a04d
TH		 817extern void ata_id_string(const u16 *id, unsigned char *s,
818 unsigned int ofs, unsigned int len);
819extern void ata_id_c_string(const u16 *id, unsigned char *s,
820 unsigned int ofs, unsigned int len);
10305f0f 821extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
1da177e4
LT		 822extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
823extern void ata_bmdma_start (struct ata_queued_cmd *qc);
b73fc89f 824extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1da177e4
LT		 825extern u8 ata_bmdma_status(struct ata_port *ap);
826extern void ata_bmdma_irq_clear(struct ata_port *ap);
6d97dbd7
TH		 827extern void ata_bmdma_freeze(struct ata_port *ap);
828extern void ata_bmdma_thaw(struct ata_port *ap);
f5914a46 829extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
6d97dbd7
TH		 830 ata_reset_fn_t softreset,
831 ata_reset_fn_t hardreset,
832 ata_postreset_fn_t postreset);
833extern void ata_bmdma_error_handler(struct ata_port *ap);
834extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
9a1004d0
TH		 835extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
836 u8 status, int in_wq);
f686bcb8 837extern void ata_qc_complete(struct ata_queued_cmd *qc);
dedaf2b0
TH		 838extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
839 void (*finish_qc)(struct ata_queued_cmd *));
3373efd8 840extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
1da177e4
LT		 841 void (*done)(struct scsi_cmnd *));
842extern int ata_std_bios_param(struct scsi_device *sdev,
843 struct block_device *bdev,
844 sector_t capacity, int geom[]);
845extern int ata_scsi_slave_config(struct scsi_device *sdev);
83c47bcb 846extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
a6e6ce8e
TH		 847extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
848 int queue_depth);
3373efd8 849extern struct ata_device *ata_dev_pair(struct ata_device *adev);
0260731f 850extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
83625006
AI		 851extern u8 ata_irq_on(struct ata_port *ap);
852extern u8 ata_dummy_irq_on(struct ata_port *ap);
853extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
854extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
1da177e4 855
be0d18df
AC		 856extern int ata_cable_40wire(struct ata_port *ap);
857extern int ata_cable_80wire(struct ata_port *ap);
858extern int ata_cable_sata(struct ata_port *ap);
859extern int ata_cable_unknown(struct ata_port *ap);
860
452503f9
AC		 861/*
862 * Timing helpers
863 */
1bc4ccff
AC		 864
865extern unsigned int ata_pio_need_iordy(const struct ata_device *);
452503f9
AC		 866extern int ata_timing_compute(struct ata_device *, unsigned short,
867 struct ata_timing *, int, int);
868extern void ata_timing_merge(const struct ata_timing *,
869 const struct ata_timing *, struct ata_timing *,
870 unsigned int);
871
872enum {
873 ATA_TIMING_SETUP = (1 << 0),
874 ATA_TIMING_ACT8B = (1 << 1),
875 ATA_TIMING_REC8B = (1 << 2),
876 ATA_TIMING_CYC8B = (1 << 3),
877 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
878 ATA_TIMING_CYC8B,
879 ATA_TIMING_ACTIVE = (1 << 4),
880 ATA_TIMING_RECOVER = (1 << 5),
881 ATA_TIMING_CYCLE = (1 << 6),
882 ATA_TIMING_UDMA = (1 << 7),
883 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
884 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
885 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
886 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
887};
888
1da177e4
LT		 889
890#ifdef CONFIG_PCI
891struct pci_bits {
892 unsigned int reg; /* PCI config register to read */
893 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
894 unsigned long mask;
895 unsigned long val;
896};
897
d583bc18 898extern int ata_pci_init_sff_host(struct ata_host *host);
1626aeb8 899extern int ata_pci_init_bmdma(struct ata_host *host);
d583bc18
TH		 900extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
901 const struct ata_port_info * const * ppi,
902 struct ata_host **r_host);
057ace5e 903extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
a76b62ca 904extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
1da177e4
LT		 905#endif /* CONFIG_PCI */
906
ece1d636
TH		 907/*
908 * EH
909 */
ece1d636 910extern void ata_eng_timeout(struct ata_port *ap);
7b70fc03
TH		 911
912extern void ata_port_schedule_eh(struct ata_port *ap);
dbd82616 913extern int ata_link_abort(struct ata_link *link);
7b70fc03 914extern int ata_port_abort(struct ata_port *ap);
e3180499
TH		 915extern int ata_port_freeze(struct ata_port *ap);
916
917extern void ata_eh_freeze_port(struct ata_port *ap);
918extern void ata_eh_thaw_port(struct ata_port *ap);
7b70fc03 919
ece1d636
TH		 920extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
921extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
922
f5914a46
TH		 923extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
924 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
925 ata_postreset_fn_t postreset);
022bdb07 926
61440db6
TH		 927/*
928 * printk helpers
929 */
930#define ata_port_printk(ap, lv, fmt, args...) \
44877b4e 931 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
61440db6 932
8989805d
TH		 933#define ata_link_printk(link, lv, fmt, args...) do { \
934 if ((link)->ap->nr_pmp_links) \
935 printk(lv"ata%u.%02u: "fmt, (link)->ap->print_id, \
936 (link)->pmp , ##args); \
937 else \
938 printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args); \
939 } while(0)
9af5c9c9 940
61440db6 941#define ata_dev_printk(dev, lv, fmt, args...) \
8989805d
TH		 942 printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, \
943 (dev)->link->pmp + (dev)->devno , ##args)
1da177e4 944
f3e81b19
TH		 945/*
946 * ata_eh_info helpers
947 */
b64bbc39
TH		 948extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
949extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
950extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
f3e81b19 951
f8f1e1cc 952static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
084fe639 953{
f8f1e1cc 954 ehi->flags |= ATA_EHI_RESUME_LINK;
084fe639
TH		 955 ehi->action |= ATA_EH_SOFTRESET;
956 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
957}
958
c0b6c037
TH		 959static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
960{
f8f1e1cc
TH		 961 ata_ehi_schedule_probe(ehi);
962 ehi->flags |= ATA_EHI_HOTPLUGGED;
c0b6c037
TH		 963 ehi->err_mask |= AC_ERR_ATA_BUS;
964}
965
61440db6
TH		 966/*
967 * qc helpers
968 */
972c26bd
JG		 969static inline int
970ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
971{
972 if (sg == &qc->pad_sgent)
973 return 1;
974 if (qc->pad_len)
975 return 0;
976 if (((sg - qc->__sg) + 1) == qc->n_elem)
977 return 1;
978 return 0;
979}
980
cc1887f3
TH		 981static inline struct scatterlist *
982ata_qc_first_sg(struct ata_queued_cmd *qc)
983{
984 if (qc->n_elem)
985 return qc->__sg;
986 if (qc->pad_len)
987 return &qc->pad_sgent;
988 return NULL;
989}
990
cedc9a47
JG		 991static inline struct scatterlist *
992ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
993{
994 if (sg == &qc->pad_sgent)
995 return NULL;
996 if (++sg - qc->__sg < qc->n_elem)
997 return sg;
cc1887f3
TH		 998 if (qc->pad_len)
999 return &qc->pad_sgent;
1000 return NULL;
cedc9a47
JG		 1001}
1002
1003#define ata_for_each_sg(sg, qc) \
cc1887f3 1004 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
cedc9a47 1005
1da177e4
LT		 1006static inline unsigned int ata_tag_valid(unsigned int tag)
1007{
1008 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1009}
1010
2ab7db1f
TH		 1011static inline unsigned int ata_tag_internal(unsigned int tag)
1012{
1013 return tag == ATA_MAX_QUEUE - 1;
1014}
1015
5806db22
TH		 1016/*
1017 * device helpers
1018 */
e1211e3f 1019static inline unsigned int ata_class_enabled(unsigned int class)
597afd21
TH		 1020{
1021 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
1022}
1023
e1211e3f 1024static inline unsigned int ata_class_disabled(unsigned int class)
1da177e4 1025{
e1211e3f
TH		 1026 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
1027}
1028
002c8054
TH		 1029static inline unsigned int ata_class_absent(unsigned int class)
1030{
1031 return !ata_class_enabled(class) && !ata_class_disabled(class);
1032}
1033
e1211e3f
TH		 1034static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1035{
1036 return ata_class_enabled(dev->class);
1037}
1038
1039static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1040{
1041 return ata_class_disabled(dev->class);
1da177e4
LT		 1042}
1043
002c8054
TH		 1044static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1045{
1046 return ata_class_absent(dev->class);
1047}
1048
5806db22 1049/*
f58229f8 1050 * link helpers
5806db22 1051 */
8989805d
TH		 1052static inline int ata_is_host_link(const struct ata_link *link)
1053{
1054 return link == &link->ap->link;
1055}
1056
f58229f8 1057static inline int ata_link_max_devices(const struct ata_link *link)
5806db22 1058{
8989805d 1059 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
5806db22
TH		 1060 return 2;
1061 return 1;
1062}
1063
8989805d
TH		 1064static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1065{
1066 if (ap->nr_pmp_links)
1067 return ap->pmp_link;
1068 return &ap->link;
1069}
1070
1071static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1072{
1073 struct ata_port *ap = link->ap;
1074
1075 if (link == &ap->link) {
1076 if (!ap->nr_pmp_links)
1077 return NULL;
1078 return ap->pmp_link;
1079 }
1080
1081 if (++link - ap->pmp_link < ap->nr_pmp_links)
1082 return link;
1083 return NULL;
1084}
1085
1086#define __ata_port_for_each_link(lk, ap) \
1087 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1088
1089#define ata_port_for_each_link(link, ap) \
1090 for ((link) = ata_port_first_link(ap); (link); \
1091 (link) = ata_port_next_link(link))
f58229f8
TH		 1092
1093#define ata_link_for_each_dev(dev, link) \
1094 for ((dev) = (link)->device; \
1095 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1096 (dev)++)
1097
1098#define ata_link_for_each_dev_reverse(dev, link) \
1099 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1100 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
5806db22 1101
1da177e4
LT		 1102static inline u8 ata_chk_status(struct ata_port *ap)
1103{
1104 return ap->ops->check_status(ap);
1105}
1106
6d1245bf
TH		 1107/**
1108 * ata_ncq_enabled - Test whether NCQ is enabled
1109 * @dev: ATA device to test for
1110 *
1111 * LOCKING:
1112 * spin_lock_irqsave(host lock)
1113 *
1114 * RETURNS:
1115 * 1 if NCQ is enabled for @dev, 0 otherwise.
1116 */
1117static inline int ata_ncq_enabled(struct ata_device *dev)
1118{
1119 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1120 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1121}
0baab86b
EF		 1122
1123/**
1124 * ata_pause - Flush writes and pause 400 nanoseconds.
1125 * @ap: Port to wait for.
1126 *
1127 * LOCKING:
1128 * Inherited from caller.
1129 */
1130
1da177e4
LT		 1131static inline void ata_pause(struct ata_port *ap)
1132{
1133 ata_altstatus(ap);
1134 ndelay(400);
1135}
1136
0baab86b
EF		 1137
1138/**
1139 * ata_busy_wait - Wait for a port status register
1140 * @ap: Port to wait for.
0777721c
AC		 1141 * @bits: bits that must be clear
1142 * @max: number of 10uS waits to perform
0baab86b
EF		 1143 *
1144 * Waits up to max*10 microseconds for the selected bits in the port's
1145 * status register to be cleared.
1146 * Returns final value of status register.
1147 *
1148 * LOCKING:
1149 * Inherited from caller.
1150 */
1151
1da177e4
LT		 1152static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1153 unsigned int max)
1154{
1155 u8 status;
1156
1157 do {
1158 udelay(10);
1159 status = ata_chk_status(ap);
1160 max--;
d1adc1bb 1161 } while (status != 0xff && (status & bits) && (max > 0));
1da177e4
LT		 1162
1163 return status;
1164}
1165
0baab86b
EF		 1166
1167/**
1168 * ata_wait_idle - Wait for a port to be idle.
1169 * @ap: Port to wait for.
1170 *
1171 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1172 * Returns final value of status register.
1173 *
1174 * LOCKING:
1175 * Inherited from caller.
1176 */
1177
1da177e4
LT		 1178static inline u8 ata_wait_idle(struct ata_port *ap)
1179{
1180 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1181
55f3952d
TH		 1182 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1183 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1184 status, ap->ioaddr.status_addr);
1da177e4
LT		 1185
1186 return status;
1187}
1188
1189static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1190{
1191 qc->tf.ctl |= ATA_NIEN;
1192}
1193
f69499f4
TH		 1194static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1195 unsigned int tag)
1da177e4
LT		 1196{
1197 if (likely(ata_tag_valid(tag)))
1198 return &ap->qcmd[tag];
1199 return NULL;
1200}
1201
f69499f4
TH		 1202static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1203 unsigned int tag)
1204{
1205 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1206
1207 if (unlikely(!qc) || !ap->ops->error_handler)
1208 return qc;
1209
1210 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1211 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1212 return qc;
1213
1214 return NULL;
1215}
1216
3373efd8 1217static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1da177e4
LT		 1218{
1219 memset(tf, 0, sizeof(*tf));
1220
9af5c9c9 1221 tf->ctl = dev->link->ap->ctl;
3373efd8 1222 if (dev->devno == 0)
1da177e4
LT		 1223 tf->device = ATA_DEVICE_OBS;
1224 else
1225 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1226}
1227
2c13b7ce
JG		 1228static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1229{
501e0c50 1230 qc->dma_dir = DMA_NONE;
2c13b7ce
JG		 1231 qc->__sg = NULL;
1232 qc->flags = 0;
726f0785 1233 qc->cursg = qc->cursg_ofs = 0;
2c13b7ce 1234 qc->nbytes = qc->curbytes = 0;
7a801184 1235 qc->n_elem = 0;
a22e2eb0 1236 qc->err_mask = 0;
d0f29485 1237 qc->pad_len = 0;
5a5dbd18 1238 qc->sect_size = ATA_SECT_SIZE;
2c13b7ce 1239
3373efd8 1240 ata_tf_init(qc->dev, &qc->tf);
e61e0672
TH		 1241
1242 /* init result_tf such that it indicates normal completion */
1243 qc->result_tf.command = ATA_DRDY;
1244 qc->result_tf.feature = 0;
2c13b7ce
JG		 1245}
1246
057ace5e 1247static inline int ata_try_flush_cache(const struct ata_device *dev)
1da177e4
LT		 1248{
1249 return ata_id_wcache_enabled(dev->id) ||
1250 ata_id_has_flush(dev->id) ||
1251 ata_id_has_flush_ext(dev->id);
1252}
1253
a7dac447
JG		 1254static inline unsigned int ac_err_mask(u8 status)
1255{
3655d1d3 1256 if (status & (ATA_BUSY | ATA_DRQ))
11a56d24 1257 return AC_ERR_HSM;
a7dac447
JG		 1258 if (status & (ATA_ERR | ATA_DF))
1259 return AC_ERR_DEV;
1260 return 0;
1261}
1262
1263static inline unsigned int __ac_err_mask(u8 status)
1264{
1265 unsigned int mask = ac_err_mask(status);
1266 if (mask == 0)
1267 return AC_ERR_OTHER;
1268 return mask;
1269}
1270
6037d6bb
JG		 1271static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1272{
1273 ap->pad_dma = 0;
f0d36efd
TH		 1274 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1275 &ap->pad_dma, GFP_KERNEL);
6037d6bb
JG		 1276 return (ap->pad == NULL) ? -ENOMEM : 0;
1277}
1278
1279static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1280{
f0d36efd 1281 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
6037d6bb
JG		 1282}
1283
35bb94b1
JG		 1284static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1285{
4911487a 1286 return *(struct ata_port **)&host->hostdata[0];
35bb94b1
JG		 1287}
1288
1da177e4 1289#endif /* __LINUX_LIBATA_H__ */