blob: 4abb758a0450d52c8e52b1b1b37bfe0c7f1762d0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * 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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
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>
Andrew Morton1c72d8d2005-11-10 16:21:38 -080032#include <linux/dma-mapping.h>
Andrew Morton41542db2006-06-23 04:18:31 -070033#include <asm/scatterlist.h>
Tejun Heof0d36ef2007-01-20 16:00:28 +090034#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/ata.h>
36#include <linux/workqueue.h>
Jeff Garzik35bb94b2006-04-11 13:12:34 -040037#include <scsi/scsi_host.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070038#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Jeff Garzika6d967a2006-09-25 15:33:09 -040040/*
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
Alan Cox2ec7df02006-08-10 16:59:10 +090045#include <asm/libata-portmap.h>
Jeff Garzika6d967a2006-09-25 15:33:09 -040046#else
47#include <asm-generic/libata-portmap.h>
48#endif
Alan Cox2ec7df02006-08-10 16:59:10 +090049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/*
Randy Dunlapbfd60572006-01-17 19:34:42 -050051 * compile-time options: to be removed as soon as all the drivers are
52 * converted to the new debugging mechanism
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 */
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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
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
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050073#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
74
Randy Dunlapbfd60572006-01-17 19:34:42 -050075/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107/* 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,
Alan Coxd26fc952007-07-06 19:13:52 -0400119 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 ATA_MAX_PORTS = 8,
121 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900122 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900123 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900124 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 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,
Jeff Garzikcf482932005-10-22 00:19:33 -0400132 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900135 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
136 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400137 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900138 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900139 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heo67465442007-05-15 03:28:16 +0900140 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
141 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
Tejun Heoea1dd4e2006-04-02 18:51:53 +0900142 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900143
Tejun Heoe5c9e082006-09-30 19:44:39 +0900144 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
Tejun Heo33435712006-10-19 14:44:53 +0900145 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
Tejun Heo13b8d092007-05-15 12:29:22 +0200146 ATA_DFLAG_SPUNDOWN = (1 << 10), /* XXX: for spindown_compat */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900147 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Tejun Heoabdda732006-05-31 18:27:29 +0900149 ATA_DFLAG_DETACH = (1 << 16),
150 ATA_DFLAG_DETACHED = (1 << 17),
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 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 */
Tejun Heo949b38a2006-04-02 18:51:52 +0900160 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900162 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 */
Tejun Heo7395acb2006-05-31 18:27:25 +0900170 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 */
Tejun Heoabdda732006-05-31 18:27:29 +0900173 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 */
Tejun Heo7395acb2006-05-31 18:27:25 +0900176 ATA_FLAG_DEBUGMSG = (1 << 13),
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900177 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800178 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Tejun Heo3cadbcc2007-05-15 03:28:15 +0900179 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
Jens Axboe9b847542006-01-06 09:28:07 +0100180
Tejun Heob51e9e52006-06-29 01:29:30 +0900181 /* 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 */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900186
Tejun Heob51e9e52006-06-29 01:29:30 +0900187 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000188
Tejun Heob51e9e52006-06-29 01:29:30 +0900189 /* 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 */
Tejun Heof4d6d002007-05-01 11:50:15 +0200197 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
Tejun Heob51e9e52006-06-29 01:29:30 +0900198
Tejun Heob51e9e52006-06-29 01:29:30 +0900199 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900200 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heo64578a32007-05-15 03:28:16 +0900201 ATA_PFLAG_GTM_VALID = (1 << 19), /* acpi_gtm data valid */
Tejun Heodde44582006-02-02 00:56:10 +0900202
Tejun Heo949b38a2006-04-02 18:51:52 +0900203 /* 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
Tejun Heo27197362006-04-02 18:51:53 +0900208 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900209 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
210
Tejun Heo9ec957f2006-05-15 20:57:58 +0900211 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) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100215 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400216 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900217 ATA_HOST_STARTED = (1 << 1), /* Host started */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400218
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000220 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
221 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900222 ATA_TMOUT_INTERNAL = 30 * HZ,
223 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
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
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900243 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 */
Alan Coxb352e572006-08-10 18:52:12 +0100245 ATA_BITS_PIO = 7,
246 ATA_BITS_MWDMA = 5,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900247 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,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400256
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,
Tejun Heo949b38a2006-04-02 18:51:52 +0900260
Tejun Heo0c247c52006-05-15 20:58:19 +0900261 /* ering size */
262 ATA_ERING_SIZE = 32,
263
Tejun Heof3e81b12006-05-15 20:58:21 +0900264 /* desc_len for ata_eh_info and context */
265 ATA_EH_DESC_LEN = 80,
266
Tejun Heo9be1e972006-05-15 20:58:17 +0900267 /* 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,
Tejun Heo9666f402007-05-04 21:27:47 +0200273 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
Tejun Heo9be1e972006-05-15 20:58:17 +0900274
Tejun Heof3e81b12006-05-15 20:58:21 +0900275 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900276 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo13abf502006-07-10 23:18:46 +0900277 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900278 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
279 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900280
Tejun Heo0d64a232007-04-23 02:41:05 +0900281 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 */
Tejun Heof3e81b12006-05-15 20:58:21 +0900286
Tejun Heo0d64a232007-04-23 02:41:05 +0900287 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900288 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
289
Tejun Heoad9e2762006-05-15 20:58:12 +0900290 /* max repeat if error condition is still set after ->error_handler */
291 ATA_EH_MAX_REPEAT = 5,
292
Tejun Heo14d2bac2006-04-02 17:54:46 +0900293 /* how hard are we gonna try to probe/recover devices */
294 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900295 ATA_EH_DEV_TRIES = 3,
Tejun Heof5914a42006-05-31 18:27:48 +0900296
Alan Cox93590852006-09-12 16:55:12 +0100297 /* 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 */
Alan Cox6919a0a2006-10-27 19:08:46 -0700301 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
302 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800303 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304};
305
Albert Lee14be71f2005-09-27 17:36:35 +0800306enum hsm_task_states {
Albert Leec56b14d2005-09-30 19:07:39 +0800307 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800308 HSM_ST_FIRST, /* (waiting the device to)
309 write CDB or first data block */
Albert Leec56b14d2005-09-30 19:07:39 +0800310 HSM_ST, /* (waiting the device to) transfer data */
311 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d2005-09-30 19:07:39 +0800312 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313};
314
Jeff Garzika7dac442005-10-30 04:44:42 -0500315enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900316 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 */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900325 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Jeff Garzika7dac442005-10-30 04:44:42 -0500326};
327
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328/* forward declarations */
329struct scsi_device;
330struct ata_port_operations;
331struct ata_port;
332struct ata_queued_cmd;
333
334/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900335typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heod4b2bab2007-02-02 16:50:52 +0900336typedef int (*ata_prereset_fn_t)(struct ata_port *ap, unsigned long deadline);
337typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes,
338 unsigned long deadline);
Tejun Heof5914a42006-05-31 18:27:48 +0900339typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900342 void __iomem *cmd_addr;
343 void __iomem *data_addr;
344 void __iomem *error_addr;
345 void __iomem *feature_addr;
346 void __iomem *nsect_addr;
347 void __iomem *lbal_addr;
348 void __iomem *lbam_addr;
349 void __iomem *lbah_addr;
350 void __iomem *device_addr;
351 void __iomem *status_addr;
352 void __iomem *command_addr;
353 void __iomem *altstatus_addr;
354 void __iomem *ctl_addr;
355 void __iomem *bmdma_addr;
356 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357};
358
Jeff Garzikcca39742006-08-24 03:19:22 -0400359struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 spinlock_t lock;
361 struct device *dev;
362 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900363 unsigned long irq2;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900364 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 unsigned int n_ports;
366 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400367 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100368 unsigned long flags;
Tejun Heofafbae82007-05-15 03:28:16 +0900369#ifdef CONFIG_ATA_ACPI
370 acpi_handle acpi_handle;
371#endif
Alan032af1c2007-03-01 17:36:46 +0000372 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900373 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374};
375
376struct ata_queued_cmd {
377 struct ata_port *ap;
378 struct ata_device *dev;
379
380 struct scsi_cmnd *scsicmd;
381 void (*scsidone)(struct scsi_cmnd *);
382
383 struct ata_taskfile tf;
384 u8 cdb[ATAPI_CDB_LEN];
385
386 unsigned long flags; /* ATA_QCFLAG_xxx */
387 unsigned int tag;
388 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400389 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 int dma_dir;
392
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400393 unsigned int pad_len;
Mark Lord5a5dbd12007-03-16 10:22:26 -0400394 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400395
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 unsigned int nbytes;
397 unsigned int curbytes;
398
399 unsigned int cursg;
400 unsigned int cursg_ofs;
401
402 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400403 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 void *buf_virt;
405
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400406 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
407 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Albert Leea22e2eb2005-12-05 15:38:02 +0800409 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900410 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 ata_qc_cb_t complete_fn;
412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800414 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415};
416
Jeff Garzikcca39742006-08-24 03:19:22 -0400417struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 unsigned long unhandled_irq;
419 unsigned long idle_irq;
420 unsigned long rw_reqbuf;
421};
422
Tejun Heo0c247c52006-05-15 20:58:19 +0900423struct ata_ering_entry {
424 int is_io;
425 unsigned int err_mask;
426 u64 timestamp;
427};
428
429struct ata_ering {
430 int cursor;
431 struct ata_ering_entry ring[ATA_ERING_SIZE];
432};
433
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434struct ata_device {
Tejun Heo38d87232006-05-15 20:57:51 +0900435 struct ata_port *ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 unsigned int devno; /* 0 or 1 */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900437 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo75683fe2007-07-05 13:31:27 +0900438 unsigned int horkage; /* List of broken features */
Tejun Heo3edebac2006-05-31 18:27:40 +0900439 struct scsi_device *sdev; /* attached SCSI device */
Tejun Heofafbae82007-05-15 03:28:16 +0900440#ifdef CONFIG_ATA_ACPI
441 acpi_handle acpi_handle;
442#endif
Tejun Heo72fa4b72006-05-31 18:27:32 +0900443 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
444 u64 n_sectors; /* size of device, if ATA */
445 unsigned int class; /* ATA_DEV_xxx */
Tejun Heofe635c72006-05-15 20:57:35 +0900446 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 u8 pio_mode;
448 u8 dma_mode;
449 u8 xfer_mode;
450 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
451
Albert Lee8cbd6df2005-10-12 15:06:27 +0800452 unsigned int multi_count; /* sectors count for
453 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900454 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900455 unsigned int cdb_len;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400456
Tejun Heoacf356b2006-03-24 14:07:50 +0900457 /* per-dev xfer mask */
458 unsigned int pio_mask;
459 unsigned int mwdma_mask;
460 unsigned int udma_mask;
461
Albert Lee8bf62ec2005-05-12 15:29:42 -0400462 /* for CHS addressing */
463 u16 cylinders; /* Number of cylinders */
464 u16 heads; /* Number of heads */
465 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900466
467 /* error history */
468 struct ata_ering ering;
Tejun Heo7d47e8d2007-02-02 16:22:31 +0900469 int spdn_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470};
471
Tejun Heo72fa4b72006-05-31 18:27:32 +0900472/* Offset into struct ata_device. Fields above it are maintained
473 * acress device init. Fields below are zeroed.
474 */
475#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
476
Tejun Heof3e81b12006-05-15 20:58:21 +0900477struct ata_eh_info {
478 struct ata_device *dev; /* offending device */
479 u32 serror; /* SError from LLDD */
480 unsigned int err_mask; /* port-wide err_mask */
481 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900482 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900483 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900484
Tejun Heoabdda732006-05-31 18:27:29 +0900485 unsigned int probe_mask;
486
Tejun Heof3e81b12006-05-15 20:58:21 +0900487 char desc[ATA_EH_DESC_LEN];
488 int desc_len;
489};
490
491struct ata_eh_context {
492 struct ata_eh_info i;
493 int tries[ATA_MAX_DEVICES];
Tejun Heoabdda732006-05-31 18:27:29 +0900494 unsigned int classes[ATA_MAX_DEVICES];
495 unsigned int did_probe_mask;
Tejun Heof3e81b12006-05-15 20:58:21 +0900496};
497
Tejun Heo64578a32007-05-15 03:28:16 +0900498struct ata_acpi_drive
499{
500 u32 pio;
501 u32 dma;
502} __packed;
503
504struct ata_acpi_gtm {
505 struct ata_acpi_drive drive[2];
506 u32 flags;
507} __packed;
508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400510 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400511 const struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400512 spinlock_t *lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 unsigned long flags; /* ATA_FLAG_xxx */
Tejun Heob51e9e52006-06-29 01:29:30 +0900514 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900515 unsigned int print_id; /* user visible unique port ID */
516 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518 struct ata_prd *prd; /* our SG list */
519 dma_addr_t prd_dma; /* and its DMA mapping */
520
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400521 void *pad; /* array of DMA pad buffers */
522 dma_addr_t pad_dma;
523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
525
526 u8 ctl; /* cache of ATA control register */
527 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 unsigned int pio_mask;
529 unsigned int mwdma_mask;
530 unsigned int udma_mask;
531 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Tejun Heo5a04bf42006-05-31 18:27:38 +0900532 unsigned int hw_sata_spd_limit;
Tejun Heo1c3fae42006-04-02 20:53:28 +0900533 unsigned int sata_spd_limit; /* SATA PHY speed limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Jeff Garzikcca39742006-08-24 03:19:22 -0400535 /* record runtime error info, protected by host lock */
Tejun Heof3e81b12006-05-15 20:58:21 +0900536 struct ata_eh_info eh_info;
537 /* EH context owned by EH */
538 struct ata_eh_context eh_context;
539
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 struct ata_device device[ATA_MAX_DEVICES];
541
542 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900543 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900544 unsigned int qc_active;
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 unsigned int active_tag;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900547 u32 sactive;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Jeff Garzikcca39742006-08-24 03:19:22 -0400549 struct ata_port_stats stats;
550 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600551 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
David Howells65f27f32006-11-22 14:55:48 +0000553 void *port_task_data;
David Howells52bad642006-11-22 14:54:01 +0000554 struct delayed_work port_task;
555 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400556 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900557
Albert Lee14be71f2005-09-27 17:36:35 +0800558 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Randy Dunlapbfd60572006-01-17 19:34:42 -0500560 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900561 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900562 wait_queue_head_t eh_wait_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500563
Tejun Heo500530f2006-07-03 16:07:27 +0900564 pm_message_t pm_mesg;
565 int *pm_result;
566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900568
Tejun Heofafbae82007-05-15 03:28:16 +0900569#ifdef CONFIG_ATA_ACPI
570 acpi_handle acpi_handle;
Tejun Heo64578a32007-05-15 03:28:16 +0900571 struct ata_acpi_gtm acpi_gtm;
Tejun Heofafbae82007-05-15 03:28:16 +0900572#endif
Tejun Heofe635c72006-05-15 20:57:35 +0900573 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574};
575
576struct ata_port_operations {
577 void (*port_disable) (struct ata_port *);
578
Alancd0d3bb2007-03-02 00:56:15 +0000579 void (*dev_config) (struct ata_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
581 void (*set_piomode) (struct ata_port *, struct ata_device *);
582 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Coxa76b62c2007-03-09 09:34:07 -0500583 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Jeff Garzik057ace52005-10-22 14:27:05 -0400585 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
587
Jeff Garzik057ace52005-10-22 14:27:05 -0400588 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 u8 (*check_status)(struct ata_port *ap);
590 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 void (*dev_select)(struct ata_port *ap, unsigned int device);
592
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900593 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Alanb229a7b2007-01-24 11:47:07 +0000594 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900595
Alan Coxbe0d18d2007-03-06 02:37:56 -0800596 int (*cable_detect) (struct ata_port *ap);
597
Alanb229a7b2007-01-24 11:47:07 +0000598 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600 void (*bmdma_setup) (struct ata_queued_cmd *qc);
601 void (*bmdma_start) (struct ata_queued_cmd *qc);
602
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100603 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900606 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Tejun Heo9ec957f2006-05-15 20:57:58 +0900608 /* Error handlers. ->error_handler overrides ->eng_timeout and
609 * indicates that new-style EH is in place.
610 */
611 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
612
613 void (*freeze) (struct ata_port *ap);
614 void (*thaw) (struct ata_port *ap);
615 void (*error_handler) (struct ata_port *ap);
616 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
David Howells7d12e782006-10-05 14:55:46 +0100618 irq_handler_t irq_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 void (*irq_clear) (struct ata_port *);
Akira Iguchi83625002007-01-26 16:27:32 +0900620 u8 (*irq_on) (struct ata_port *);
621 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
623 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
624 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
625 u32 val);
626
Tejun Heo500530f2006-07-03 16:07:27 +0900627 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
628 int (*port_resume) (struct ata_port *ap);
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 int (*port_start) (struct ata_port *ap);
631 void (*port_stop) (struct ata_port *ap);
632
Jeff Garzikcca39742006-08-24 03:19:22 -0400633 void (*host_stop) (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Alan Coxb73fc892005-08-26 16:03:19 +0100635 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 u8 (*bmdma_status) (struct ata_port *ap);
637};
638
639struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100640 struct scsi_host_template *sht;
Jeff Garzikcca39742006-08-24 03:19:22 -0400641 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 unsigned long pio_mask;
643 unsigned long mwdma_mask;
644 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400645 const struct ata_port_operations *port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900646 irq_handler_t irq_handler;
Alan Coxe99f8b52005-11-08 14:09:44 +0000647 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648};
649
Alan Cox452503f2005-10-21 19:01:32 -0400650struct ata_timing {
651 unsigned short mode; /* ATA mode */
652 unsigned short setup; /* t1 */
653 unsigned short act8b; /* t2 for 8-bit I/O */
654 unsigned short rec8b; /* t2i for 8-bit I/O */
655 unsigned short cyc8b; /* t0 for 8-bit I/O */
656 unsigned short active; /* t2 or tD */
657 unsigned short recover; /* t2i or tK */
658 unsigned short cycle; /* t0 */
659 unsigned short udma; /* t2CYCTYP/2 */
660};
661
662#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Tejun Heoe9c83912006-07-03 16:07:26 +0900664extern const unsigned long sata_deb_timing_normal[];
665extern const unsigned long sata_deb_timing_hotplug[];
666extern const unsigned long sata_deb_timing_long[];
667
Tejun Heodd5b06c2006-08-10 16:59:12 +0900668extern const struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900669extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900670
Tejun Heoe9c83912006-07-03 16:07:26 +0900671static inline const unsigned long *
672sata_ehc_deb_timing(struct ata_eh_context *ehc)
673{
674 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
675 return sata_deb_timing_hotplug;
676 else
677 return sata_deb_timing_normal;
678}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900679
Tejun Heodd5b06c2006-08-10 16:59:12 +0900680static inline int ata_port_is_dummy(struct ata_port *ap)
681{
682 return ap->ops == &ata_dummy_port_ops;
683}
684
Jeff Garzik43727fb2007-02-25 16:50:52 -0500685extern void sata_print_link_status(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686extern void ata_port_probe(struct ata_port *);
687extern void __sata_phy_reset(struct ata_port *ap);
688extern void sata_phy_reset(struct ata_port *ap);
689extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo3c567b72006-05-15 20:57:23 +0900690extern int sata_set_spd(struct ata_port *ap);
Tejun Heod4b2bab2007-02-02 16:50:52 +0900691extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param,
692 unsigned long deadline);
693extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param,
694 unsigned long deadline);
695extern int ata_std_prereset(struct ata_port *ap, unsigned long deadline);
696extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes,
697 unsigned long deadline);
698extern int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing,
699 unsigned long deadline);
700extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class,
701 unsigned long deadline);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900702extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703extern void ata_port_disable(struct ata_port *);
704extern void ata_std_ports(struct ata_ioports *ioaddr);
705#ifdef CONFIG_PCI
Tejun Heo1626aeb2007-05-04 12:43:58 +0200706extern int ata_pci_init_one (struct pci_dev *pdev,
707 const struct ata_port_info * const * ppi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708extern void ata_pci_remove_one (struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900709#ifdef CONFIG_PM
Tejun Heo3c5100c2006-07-26 16:58:33 +0900710extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
Tejun Heo553c4aa2006-12-26 19:39:50 +0900711extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900712extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
Jens Axboe9b847542006-01-06 09:28:07 +0100713extern int ata_pci_device_resume(struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900714#endif
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500715extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716#endif /* CONFIG_PCI */
Tejun Heof3187192007-04-17 23:44:07 +0900717extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +0900718extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
719 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heoecef7252007-04-17 23:44:06 +0900720extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +0900721extern int ata_host_register(struct ata_host *host,
722 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +0900723extern int ata_host_activate(struct ata_host *host, int irq,
724 irq_handler_t irq_handler, unsigned long irq_flags,
725 struct scsi_host_template *sht);
Tejun Heo0529c152007-01-20 16:00:26 +0900726extern void ata_host_detach(struct ata_host *host);
Jeff Garzikcca39742006-08-24 03:19:22 -0400727extern void ata_host_init(struct ata_host *, struct device *,
728 unsigned long, const struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -0500729extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
731extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Brian King80289162006-08-07 14:27:31 -0500732extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400733extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500734 struct ata_port_info *, struct Scsi_Host *);
735extern int ata_sas_port_init(struct ata_port *);
736extern int ata_sas_port_start(struct ata_port *ap);
737extern void ata_sas_port_stop(struct ata_port *ap);
738extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
739extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
740 struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo34bf2172006-05-15 20:57:46 +0900742extern int sata_scr_valid(struct ata_port *ap);
743extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
744extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
745extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
746extern int ata_port_online(struct ata_port *ap);
747extern int ata_port_offline(struct ata_port *ap);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900748#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -0400749extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
750extern void ata_host_resume(struct ata_host *host);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900751#endif
Jeff Garzik67846b32005-10-05 02:58:32 -0400752extern int ata_ratelimit(void);
Tejun Heod1adc1b2006-10-09 18:32:15 +0900753extern int ata_busy_sleep(struct ata_port *ap,
754 unsigned long timeout_pat, unsigned long timeout);
Tejun Heod4b2bab2007-02-02 16:50:52 +0900755extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
David Howells65f27f32006-11-22 14:55:48 +0000756extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
Tejun Heo86e45b62006-03-05 15:29:09 +0900757 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900758extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
759 unsigned long interval_msec,
760 unsigned long timeout_msec);
Akira Iguchia619f981b2007-01-26 16:28:18 +0900761extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
Jeff Garzik67846b32005-10-05 02:58:32 -0400762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763/*
764 * Default driver ops implementations
765 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400766extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400768extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
769extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
771extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
772extern u8 ata_check_status(struct ata_port *ap);
773extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400774extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775extern int ata_port_start (struct ata_port *ap);
Alan Coxd92e74d2007-06-07 16:19:15 +0100776extern int ata_sff_port_start (struct ata_port *ap);
David Howells7d12e782006-10-05 14:55:46 +0100777extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900778extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
779 unsigned int buflen, int write_data);
780extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
781 unsigned int buflen, int write_data);
Alan Coxd26fc952007-07-06 19:13:52 -0400782extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600784extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900785extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
787 unsigned int buflen);
788extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
789 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400790extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +0000791extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +0900792extern void ata_id_string(const u16 *id, unsigned char *s,
793 unsigned int ofs, unsigned int len);
794extern void ata_id_c_string(const u16 *id, unsigned char *s,
795 unsigned int ofs, unsigned int len);
Alan10305f02007-02-20 18:01:59 +0000796extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
798extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100799extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800extern u8 ata_bmdma_status(struct ata_port *ap);
801extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900802extern void ata_bmdma_freeze(struct ata_port *ap);
803extern void ata_bmdma_thaw(struct ata_port *ap);
Tejun Heof5914a42006-05-31 18:27:48 +0900804extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900805 ata_reset_fn_t softreset,
806 ata_reset_fn_t hardreset,
807 ata_postreset_fn_t postreset);
808extern void ata_bmdma_error_handler(struct ata_port *ap);
809extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo9a1004d2006-05-31 18:27:52 +0900810extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
811 u8 status, int in_wq);
Tejun Heof686bcb2006-05-15 20:58:05 +0900812extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900813extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
814 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900815extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 void (*done)(struct scsi_cmnd *));
817extern int ata_std_bios_param(struct scsi_device *sdev,
818 struct block_device *bdev,
819 sector_t capacity, int geom[]);
820extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900821extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900822extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
823 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900824extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Alan04351822007-03-06 02:37:52 -0800825extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
Akira Iguchi83625002007-01-26 16:27:32 +0900826extern u8 ata_irq_on(struct ata_port *ap);
827extern u8 ata_dummy_irq_on(struct ata_port *ap);
828extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
829extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Alan Coxbe0d18d2007-03-06 02:37:56 -0800831extern int ata_cable_40wire(struct ata_port *ap);
832extern int ata_cable_80wire(struct ata_port *ap);
833extern int ata_cable_sata(struct ata_port *ap);
834extern int ata_cable_unknown(struct ata_port *ap);
835
Alan Cox452503f2005-10-21 19:01:32 -0400836/*
837 * Timing helpers
838 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000839
840extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400841extern int ata_timing_compute(struct ata_device *, unsigned short,
842 struct ata_timing *, int, int);
843extern void ata_timing_merge(const struct ata_timing *,
844 const struct ata_timing *, struct ata_timing *,
845 unsigned int);
846
847enum {
848 ATA_TIMING_SETUP = (1 << 0),
849 ATA_TIMING_ACT8B = (1 << 1),
850 ATA_TIMING_REC8B = (1 << 2),
851 ATA_TIMING_CYC8B = (1 << 3),
852 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
853 ATA_TIMING_CYC8B,
854 ATA_TIMING_ACTIVE = (1 << 4),
855 ATA_TIMING_RECOVER = (1 << 5),
856 ATA_TIMING_CYCLE = (1 << 6),
857 ATA_TIMING_UDMA = (1 << 7),
858 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
859 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
860 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
861 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
862};
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
865#ifdef CONFIG_PCI
866struct pci_bits {
867 unsigned int reg; /* PCI config register to read */
868 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
869 unsigned long mask;
870 unsigned long val;
871};
872
Tejun Heod583bc12007-07-04 18:02:07 +0900873extern int ata_pci_init_sff_host(struct ata_host *host);
Tejun Heo1626aeb2007-05-04 12:43:58 +0200874extern int ata_pci_init_bmdma(struct ata_host *host);
Tejun Heod583bc12007-07-04 18:02:07 +0900875extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
876 const struct ata_port_info * const * ppi,
877 struct ata_host **r_host);
Jeff Garzik057ace52005-10-22 14:27:05 -0400878extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Alan Coxa76b62c2007-03-09 09:34:07 -0500879extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880#endif /* CONFIG_PCI */
881
Tejun Heoece1d632006-04-02 18:51:53 +0900882/*
883 * EH
884 */
Tejun Heoece1d632006-04-02 18:51:53 +0900885extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900886
887extern void ata_port_schedule_eh(struct ata_port *ap);
888extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900889extern int ata_port_freeze(struct ata_port *ap);
890
891extern void ata_eh_freeze_port(struct ata_port *ap);
892extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900893
Tejun Heoece1d632006-04-02 18:51:53 +0900894extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
895extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
896
Tejun Heof5914a42006-05-31 18:27:48 +0900897extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
898 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
899 ata_postreset_fn_t postreset);
Tejun Heo022bdb02006-05-15 20:58:22 +0900900
Tejun Heo61440db2006-05-15 20:57:55 +0900901/*
902 * printk helpers
903 */
904#define ata_port_printk(ap, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900905 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Tejun Heo61440db2006-05-15 20:57:55 +0900907#define ata_dev_printk(dev, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900908 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
Tejun Heo61440db2006-05-15 20:57:55 +0900909
910/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900911 * ata_eh_info helpers
912 */
913#define ata_ehi_push_desc(ehi, fmt, args...) do { \
914 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
915 ATA_EH_DESC_LEN - (ehi)->desc_len, \
916 fmt , ##args); \
917} while (0)
918
919#define ata_ehi_clear_desc(ehi) do { \
920 (ehi)->desc[0] = '\0'; \
921 (ehi)->desc_len = 0; \
922} while (0)
923
Tejun Heoc0b6c032006-07-03 16:07:26 +0900924static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
Tejun Heo084fe632006-05-31 18:28:03 +0900925{
Tejun Heo28324302006-07-03 16:07:26 +0900926 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
Tejun Heo084fe632006-05-31 18:28:03 +0900927 ehi->action |= ATA_EH_SOFTRESET;
928 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
929}
930
Tejun Heoc0b6c032006-07-03 16:07:26 +0900931static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
932{
933 __ata_ehi_hotplugged(ehi);
934 ehi->err_mask |= AC_ERR_ATA_BUS;
935}
936
Tejun Heof3e81b12006-05-15 20:58:21 +0900937/*
Tejun Heo61440db2006-05-15 20:57:55 +0900938 * qc helpers
939 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400940static inline int
941ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
942{
943 if (sg == &qc->pad_sgent)
944 return 1;
945 if (qc->pad_len)
946 return 0;
947 if (((sg - qc->__sg) + 1) == qc->n_elem)
948 return 1;
949 return 0;
950}
951
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400952static inline struct scatterlist *
Tejun Heocc1887f2006-02-20 23:48:38 +0900953ata_qc_first_sg(struct ata_queued_cmd *qc)
954{
955 if (qc->n_elem)
956 return qc->__sg;
957 if (qc->pad_len)
958 return &qc->pad_sgent;
959 return NULL;
960}
961
962static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400963ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
964{
965 if (sg == &qc->pad_sgent)
966 return NULL;
967 if (++sg - qc->__sg < qc->n_elem)
968 return sg;
Tejun Heocc1887f2006-02-20 23:48:38 +0900969 if (qc->pad_len)
970 return &qc->pad_sgent;
971 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400972}
973
974#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f2006-02-20 23:48:38 +0900975 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400976
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977static inline unsigned int ata_tag_valid(unsigned int tag)
978{
979 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
980}
981
Tejun Heo2ab7db12006-05-15 20:58:02 +0900982static inline unsigned int ata_tag_internal(unsigned int tag)
983{
984 return tag == ATA_MAX_QUEUE - 1;
985}
986
Tejun Heo5806db22006-06-24 20:30:19 +0900987/*
988 * device helpers
989 */
Tejun Heoe1211e32006-04-01 01:38:18 +0900990static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +0900991{
992 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
993}
994
Tejun Heoe1211e32006-04-01 01:38:18 +0900995static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996{
Tejun Heoe1211e32006-04-01 01:38:18 +0900997 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
998}
999
Tejun Heo002c8052006-04-02 17:54:46 +09001000static inline unsigned int ata_class_absent(unsigned int class)
1001{
1002 return !ata_class_enabled(class) && !ata_class_disabled(class);
1003}
1004
Tejun Heoe1211e32006-04-01 01:38:18 +09001005static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1006{
1007 return ata_class_enabled(dev->class);
1008}
1009
1010static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1011{
1012 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013}
1014
Tejun Heo002c8052006-04-02 17:54:46 +09001015static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1016{
1017 return ata_class_absent(dev->class);
1018}
1019
Tejun Heo5806db22006-06-24 20:30:19 +09001020/*
1021 * port helpers
1022 */
1023static inline int ata_port_max_devices(const struct ata_port *ap)
1024{
1025 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1026 return 2;
1027 return 1;
1028}
1029
1030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031static inline u8 ata_chk_status(struct ata_port *ap)
1032{
1033 return ap->ops->check_status(ap);
1034}
1035
Tejun Heo6d1245b2007-02-20 23:20:27 +09001036/**
1037 * ata_ncq_enabled - Test whether NCQ is enabled
1038 * @dev: ATA device to test for
1039 *
1040 * LOCKING:
1041 * spin_lock_irqsave(host lock)
1042 *
1043 * RETURNS:
1044 * 1 if NCQ is enabled for @dev, 0 otherwise.
1045 */
1046static inline int ata_ncq_enabled(struct ata_device *dev)
1047{
1048 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1049 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1050}
Edward Falk0baab862005-06-02 18:17:13 -04001051
1052/**
1053 * ata_pause - Flush writes and pause 400 nanoseconds.
1054 * @ap: Port to wait for.
1055 *
1056 * LOCKING:
1057 * Inherited from caller.
1058 */
1059
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060static inline void ata_pause(struct ata_port *ap)
1061{
1062 ata_altstatus(ap);
1063 ndelay(400);
1064}
1065
Edward Falk0baab862005-06-02 18:17:13 -04001066
1067/**
1068 * ata_busy_wait - Wait for a port status register
1069 * @ap: Port to wait for.
Alan07777212007-01-31 17:47:24 +00001070 * @bits: bits that must be clear
1071 * @max: number of 10uS waits to perform
Edward Falk0baab862005-06-02 18:17:13 -04001072 *
1073 * Waits up to max*10 microseconds for the selected bits in the port's
1074 * status register to be cleared.
1075 * Returns final value of status register.
1076 *
1077 * LOCKING:
1078 * Inherited from caller.
1079 */
1080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1082 unsigned int max)
1083{
1084 u8 status;
1085
1086 do {
1087 udelay(10);
1088 status = ata_chk_status(ap);
1089 max--;
Tejun Heod1adc1b2006-10-09 18:32:15 +09001090 } while (status != 0xff && (status & bits) && (max > 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
1092 return status;
1093}
1094
Edward Falk0baab862005-06-02 18:17:13 -04001095
1096/**
1097 * ata_wait_idle - Wait for a port to be idle.
1098 * @ap: Port to wait for.
1099 *
1100 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1101 * Returns final value of status register.
1102 *
1103 * LOCKING:
1104 * Inherited from caller.
1105 */
1106
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107static inline u8 ata_wait_idle(struct ata_port *ap)
1108{
1109 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1110
Tejun Heo55f39522007-06-25 21:31:05 +09001111 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1112 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1113 status, ap->ioaddr.status_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114
1115 return status;
1116}
1117
1118static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1119{
1120 qc->tf.ctl |= ATA_NIEN;
1121}
1122
Tejun Heof69499f2006-05-15 20:58:03 +09001123static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1124 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125{
1126 if (likely(ata_tag_valid(tag)))
1127 return &ap->qcmd[tag];
1128 return NULL;
1129}
1130
Tejun Heof69499f2006-05-15 20:58:03 +09001131static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1132 unsigned int tag)
1133{
1134 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1135
1136 if (unlikely(!qc) || !ap->ops->error_handler)
1137 return qc;
1138
1139 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1140 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1141 return qc;
1142
1143 return NULL;
1144}
1145
Tejun Heo3373efd2006-05-15 20:57:53 +09001146static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147{
1148 memset(tf, 0, sizeof(*tf));
1149
Tejun Heo3373efd2006-05-15 20:57:53 +09001150 tf->ctl = dev->ap->ctl;
1151 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 tf->device = ATA_DEVICE_OBS;
1153 else
1154 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1155}
1156
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001157static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1158{
Tejun Heo501e0c52007-01-17 11:34:02 +09001159 qc->dma_dir = DMA_NONE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001160 qc->__sg = NULL;
1161 qc->flags = 0;
Tejun Heo726f0782007-01-03 17:30:39 +09001162 qc->cursg = qc->cursg_ofs = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001163 qc->nbytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001164 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001165 qc->err_mask = 0;
Brian Kingd0f29482007-01-17 12:32:28 -06001166 qc->pad_len = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001167 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001168
Tejun Heo3373efd2006-05-15 20:57:53 +09001169 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001170
1171 /* init result_tf such that it indicates normal completion */
1172 qc->result_tf.command = ATA_DRDY;
1173 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001174}
1175
Jeff Garzik057ace52005-10-22 14:27:05 -04001176static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177{
1178 return ata_id_wcache_enabled(dev->id) ||
1179 ata_id_has_flush(dev->id) ||
1180 ata_id_has_flush_ext(dev->id);
1181}
1182
Jeff Garzika7dac442005-10-30 04:44:42 -05001183static inline unsigned int ac_err_mask(u8 status)
1184{
Albert Lee3655d1d2006-05-19 11:43:04 +08001185 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001186 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001187 if (status & (ATA_ERR | ATA_DF))
1188 return AC_ERR_DEV;
1189 return 0;
1190}
1191
1192static inline unsigned int __ac_err_mask(u8 status)
1193{
1194 unsigned int mask = ac_err_mask(status);
1195 if (mask == 0)
1196 return AC_ERR_OTHER;
1197 return mask;
1198}
1199
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001200static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1201{
1202 ap->pad_dma = 0;
Tejun Heof0d36ef2007-01-20 16:00:28 +09001203 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1204 &ap->pad_dma, GFP_KERNEL);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001205 return (ap->pad == NULL) ? -ENOMEM : 0;
1206}
1207
1208static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1209{
Tejun Heof0d36ef2007-01-20 16:00:28 +09001210 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001211}
1212
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001213static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1214{
Tejun Heo49114872007-04-17 23:44:06 +09001215 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001216}
1217
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218#endif /* __LINUX_LIBATA_H__ */