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