blob: e7882ba63e7839a6902083215a33654b4e8315cb [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
Tejun Heob8b275e2007-07-10 15:55:43 +0900219 /* bits 24:31 of host->flags are reserved for LLD specific flags */
220
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000222 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
223 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900224 ATA_TMOUT_INTERNAL = 30 * HZ,
225 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227 /* ATA bus states */
228 BUS_UNKNOWN = 0,
229 BUS_DMA = 1,
230 BUS_IDLE = 2,
231 BUS_NOINTR = 3,
232 BUS_NODATA = 4,
233 BUS_TIMER = 5,
234 BUS_PIO = 6,
235 BUS_EDD = 7,
236 BUS_IDENTIFY = 8,
237 BUS_PACKET = 9,
238
239 /* SATA port states */
240 PORT_UNKNOWN = 0,
241 PORT_ENABLED = 1,
242 PORT_DISABLED = 2,
243
244 /* encoding various smaller bitmaps into a single
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900245 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 */
Alan Coxb352e572006-08-10 18:52:12 +0100247 ATA_BITS_PIO = 7,
248 ATA_BITS_MWDMA = 5,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900249 ATA_BITS_UDMA = 8,
250
251 ATA_SHIFT_PIO = 0,
252 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
253 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
254
255 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
256 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
257 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400258
259 /* size of buffer to pad xfers ending on unaligned boundaries */
260 ATA_DMA_PAD_SZ = 4,
261 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Tejun Heo949b38a2006-04-02 18:51:52 +0900262
Tejun Heo0c247c52006-05-15 20:58:19 +0900263 /* ering size */
264 ATA_ERING_SIZE = 32,
265
Tejun Heof3e81b12006-05-15 20:58:21 +0900266 /* desc_len for ata_eh_info and context */
267 ATA_EH_DESC_LEN = 80,
268
Tejun Heo9be1e972006-05-15 20:58:17 +0900269 /* reset / recovery action types */
270 ATA_EH_REVALIDATE = (1 << 0),
271 ATA_EH_SOFTRESET = (1 << 1),
272 ATA_EH_HARDRESET = (1 << 2),
273
274 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heo9666f402007-05-04 21:27:47 +0200275 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
Tejun Heo9be1e972006-05-15 20:58:17 +0900276
Tejun Heof3e81b12006-05-15 20:58:21 +0900277 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900278 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo13abf502006-07-10 23:18:46 +0900279 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900280 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
281 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900282
Tejun Heo0d64a232007-04-23 02:41:05 +0900283 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
284 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
285 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
286 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
287 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900288
Tejun Heo0d64a232007-04-23 02:41:05 +0900289 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900290 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
291
Tejun Heoad9e2762006-05-15 20:58:12 +0900292 /* max repeat if error condition is still set after ->error_handler */
293 ATA_EH_MAX_REPEAT = 5,
294
Tejun Heo14d2bac2006-04-02 17:54:46 +0900295 /* how hard are we gonna try to probe/recover devices */
296 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900297 ATA_EH_DEV_TRIES = 3,
Tejun Heof5914a42006-05-31 18:27:48 +0900298
Alan Cox93590852006-09-12 16:55:12 +0100299 /* Horkage types. May be set by libata or controller on drives
300 (some horkage may be drive/controller pair dependant */
301
302 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700303 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
304 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800305 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Tejun Heo16c55b02007-08-29 11:58:33 +0900306 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307};
308
Albert Lee14be71f2005-09-27 17:36:35 +0800309enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800310 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800311 HSM_ST_FIRST, /* (waiting the device to)
312 write CDB or first data block */
Albert Leec56b14d22005-09-30 19:07:39 +0800313 HSM_ST, /* (waiting the device to) transfer data */
314 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800315 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316};
317
Jeff Garzika7dac442005-10-30 04:44:42 -0500318enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900319 AC_ERR_DEV = (1 << 0), /* device reported error */
320 AC_ERR_HSM = (1 << 1), /* host state machine violation */
321 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
322 AC_ERR_MEDIA = (1 << 3), /* media error */
323 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
324 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
325 AC_ERR_SYSTEM = (1 << 6), /* system error */
326 AC_ERR_INVALID = (1 << 7), /* invalid argument */
327 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900328 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Tejun Heo5335b722007-07-16 14:29:40 +0900329 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
Jeff Garzika7dac442005-10-30 04:44:42 -0500330};
331
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332/* forward declarations */
333struct scsi_device;
334struct ata_port_operations;
335struct ata_port;
336struct ata_queued_cmd;
337
338/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900339typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heod4b2bab2007-02-02 16:50:52 +0900340typedef int (*ata_prereset_fn_t)(struct ata_port *ap, unsigned long deadline);
341typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes,
342 unsigned long deadline);
Tejun Heof5914a42006-05-31 18:27:48 +0900343typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900346 void __iomem *cmd_addr;
347 void __iomem *data_addr;
348 void __iomem *error_addr;
349 void __iomem *feature_addr;
350 void __iomem *nsect_addr;
351 void __iomem *lbal_addr;
352 void __iomem *lbam_addr;
353 void __iomem *lbah_addr;
354 void __iomem *device_addr;
355 void __iomem *status_addr;
356 void __iomem *command_addr;
357 void __iomem *altstatus_addr;
358 void __iomem *ctl_addr;
359 void __iomem *bmdma_addr;
360 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361};
362
Jeff Garzikcca39742006-08-24 03:19:22 -0400363struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 spinlock_t lock;
365 struct device *dev;
366 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900367 unsigned long irq2;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900368 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 unsigned int n_ports;
370 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400371 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100372 unsigned long flags;
Tejun Heofafbae82007-05-15 03:28:16 +0900373#ifdef CONFIG_ATA_ACPI
374 acpi_handle acpi_handle;
375#endif
Alan032af1c2007-03-01 17:36:46 +0000376 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900377 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378};
379
380struct ata_queued_cmd {
381 struct ata_port *ap;
382 struct ata_device *dev;
383
384 struct scsi_cmnd *scsicmd;
385 void (*scsidone)(struct scsi_cmnd *);
386
387 struct ata_taskfile tf;
388 u8 cdb[ATAPI_CDB_LEN];
389
390 unsigned long flags; /* ATA_QCFLAG_xxx */
391 unsigned int tag;
392 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400393 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 int dma_dir;
396
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400397 unsigned int pad_len;
Mark Lord5a5dbd12007-03-16 10:22:26 -0400398 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 unsigned int nbytes;
401 unsigned int curbytes;
402
403 unsigned int cursg;
404 unsigned int cursg_ofs;
405
406 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400407 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 void *buf_virt;
409
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400410 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
411 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Albert Leea22e2eb2005-12-05 15:38:02 +0800413 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900414 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 ata_qc_cb_t complete_fn;
416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800418 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419};
420
Jeff Garzikcca39742006-08-24 03:19:22 -0400421struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 unsigned long unhandled_irq;
423 unsigned long idle_irq;
424 unsigned long rw_reqbuf;
425};
426
Tejun Heo0c247c52006-05-15 20:58:19 +0900427struct ata_ering_entry {
428 int is_io;
429 unsigned int err_mask;
430 u64 timestamp;
431};
432
433struct ata_ering {
434 int cursor;
435 struct ata_ering_entry ring[ATA_ERING_SIZE];
436};
437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438struct ata_device {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900439 struct ata_link *link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 unsigned int devno; /* 0 or 1 */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900441 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo75683fe2007-07-05 13:31:27 +0900442 unsigned int horkage; /* List of broken features */
Tejun Heo3edebac2006-05-31 18:27:40 +0900443 struct scsi_device *sdev; /* attached SCSI device */
Tejun Heofafbae82007-05-15 03:28:16 +0900444#ifdef CONFIG_ATA_ACPI
445 acpi_handle acpi_handle;
446#endif
Tejun Heo72fa4b72006-05-31 18:27:32 +0900447 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
448 u64 n_sectors; /* size of device, if ATA */
449 unsigned int class; /* ATA_DEV_xxx */
Tejun Heofe635c72006-05-15 20:57:35 +0900450 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 u8 pio_mode;
452 u8 dma_mode;
453 u8 xfer_mode;
454 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
455
Albert Lee8cbd6df2005-10-12 15:06:27 +0800456 unsigned int multi_count; /* sectors count for
457 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900458 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900459 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400460
Tejun Heoacf356b2006-03-24 14:07:50 +0900461 /* per-dev xfer mask */
462 unsigned int pio_mask;
463 unsigned int mwdma_mask;
464 unsigned int udma_mask;
465
Albert Lee8bf62ece2005-05-12 15:29:42 -0400466 /* for CHS addressing */
467 u16 cylinders; /* Number of cylinders */
468 u16 heads; /* Number of heads */
469 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900470
471 /* error history */
472 struct ata_ering ering;
Tejun Heo7d47e8d2007-02-02 16:22:31 +0900473 int spdn_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474};
475
Tejun Heo72fa4b72006-05-31 18:27:32 +0900476/* Offset into struct ata_device. Fields above it are maintained
477 * acress device init. Fields below are zeroed.
478 */
479#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
480
Tejun Heof3e81b12006-05-15 20:58:21 +0900481struct ata_eh_info {
482 struct ata_device *dev; /* offending device */
483 u32 serror; /* SError from LLDD */
484 unsigned int err_mask; /* port-wide err_mask */
485 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900486 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900487 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900488
Tejun Heoabdda732006-05-31 18:27:29 +0900489 unsigned int probe_mask;
490
Tejun Heof3e81b12006-05-15 20:58:21 +0900491 char desc[ATA_EH_DESC_LEN];
492 int desc_len;
493};
494
495struct ata_eh_context {
496 struct ata_eh_info i;
497 int tries[ATA_MAX_DEVICES];
Tejun Heoabdda732006-05-31 18:27:29 +0900498 unsigned int classes[ATA_MAX_DEVICES];
499 unsigned int did_probe_mask;
Tejun Heof3e81b12006-05-15 20:58:21 +0900500};
501
Tejun Heo64578a32007-05-15 03:28:16 +0900502struct ata_acpi_drive
503{
504 u32 pio;
505 u32 dma;
506} __packed;
507
508struct ata_acpi_gtm {
509 struct ata_acpi_drive drive[2];
510 u32 flags;
511} __packed;
512
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900513struct ata_link {
514 struct ata_port *ap;
515
516 unsigned int active_tag; /* active tag on this link */
517 u32 sactive; /* active NCQ commands */
518
519 unsigned int hw_sata_spd_limit;
520 unsigned int sata_spd_limit;
521 unsigned int sata_spd; /* current SATA PHY speed */
522
523 /* record runtime error info, protected by host_set lock */
524 struct ata_eh_info eh_info;
525 /* EH context */
526 struct ata_eh_context eh_context;
527
528 struct ata_device device[ATA_MAX_DEVICES];
529};
530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400532 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400533 const struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400534 spinlock_t *lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 unsigned long flags; /* ATA_FLAG_xxx */
Tejun Heob51e9e52006-06-29 01:29:30 +0900536 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900537 unsigned int print_id; /* user visible unique port ID */
538 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540 struct ata_prd *prd; /* our SG list */
541 dma_addr_t prd_dma; /* and its DMA mapping */
542
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400543 void *pad; /* array of DMA pad buffers */
544 dma_addr_t pad_dma;
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
547
548 u8 ctl; /* cache of ATA control register */
549 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 unsigned int pio_mask;
551 unsigned int mwdma_mask;
552 unsigned int udma_mask;
553 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
555 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900556 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900557 unsigned int qc_active;
558
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900559 struct ata_link link; /* host default link */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Jeff Garzikcca39742006-08-24 03:19:22 -0400561 struct ata_port_stats stats;
562 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600563 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
David Howells65f27f32006-11-22 14:55:48 +0000565 void *port_task_data;
David Howells52bad642006-11-22 14:54:01 +0000566 struct delayed_work port_task;
567 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400568 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900569
Albert Lee14be71f2005-09-27 17:36:35 +0800570 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Randy Dunlapbfd60572006-01-17 19:34:42 -0500572 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900573 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900574 wait_queue_head_t eh_wait_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500575
Tejun Heo500530f2006-07-03 16:07:27 +0900576 pm_message_t pm_mesg;
577 int *pm_result;
578
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900579 struct timer_list fastdrain_timer;
580 unsigned long fastdrain_cnt;
581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900583
Tejun Heofafbae82007-05-15 03:28:16 +0900584#ifdef CONFIG_ATA_ACPI
585 acpi_handle acpi_handle;
Tejun Heo64578a32007-05-15 03:28:16 +0900586 struct ata_acpi_gtm acpi_gtm;
Tejun Heofafbae82007-05-15 03:28:16 +0900587#endif
Tejun Heofe635c72006-05-15 20:57:35 +0900588 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589};
590
591struct ata_port_operations {
592 void (*port_disable) (struct ata_port *);
593
Alancd0d3bb2007-03-02 00:56:15 +0000594 void (*dev_config) (struct ata_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
596 void (*set_piomode) (struct ata_port *, struct ata_device *);
597 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Coxa76b62c2007-03-09 09:34:07 -0500598 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Jeff Garzik057ace52005-10-22 14:27:05 -0400600 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
602
Jeff Garzik057ace52005-10-22 14:27:05 -0400603 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 u8 (*check_status)(struct ata_port *ap);
605 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 void (*dev_select)(struct ata_port *ap, unsigned int device);
607
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900608 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Alanb229a7b2007-01-24 11:47:07 +0000609 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900610
Alan Coxbe0d18d2007-03-06 02:37:56 -0800611 int (*cable_detect) (struct ata_port *ap);
612
Alanb229a7b2007-01-24 11:47:07 +0000613 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
615 void (*bmdma_setup) (struct ata_queued_cmd *qc);
616 void (*bmdma_start) (struct ata_queued_cmd *qc);
617
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100618 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900621 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Tejun Heo9ec957f2006-05-15 20:57:58 +0900623 /* Error handlers. ->error_handler overrides ->eng_timeout and
624 * indicates that new-style EH is in place.
625 */
626 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
627
628 void (*freeze) (struct ata_port *ap);
629 void (*thaw) (struct ata_port *ap);
630 void (*error_handler) (struct ata_port *ap);
631 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
David Howells7d12e782006-10-05 14:55:46 +0100633 irq_handler_t irq_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 void (*irq_clear) (struct ata_port *);
Akira Iguchi83625002007-01-26 16:27:32 +0900635 u8 (*irq_on) (struct ata_port *);
636 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Tejun Heoda3dbb12007-07-16 14:29:40 +0900638 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
639 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Tejun Heo500530f2006-07-03 16:07:27 +0900641 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
642 int (*port_resume) (struct ata_port *ap);
643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 int (*port_start) (struct ata_port *ap);
645 void (*port_stop) (struct ata_port *ap);
646
Jeff Garzikcca39742006-08-24 03:19:22 -0400647 void (*host_stop) (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Alan Coxb73fc892005-08-26 16:03:19 +0100649 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 u8 (*bmdma_status) (struct ata_port *ap);
651};
652
653struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100654 struct scsi_host_template *sht;
Jeff Garzikcca39742006-08-24 03:19:22 -0400655 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 unsigned long pio_mask;
657 unsigned long mwdma_mask;
658 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400659 const struct ata_port_operations *port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900660 irq_handler_t irq_handler;
Alan Coxe99f8b52005-11-08 14:09:44 +0000661 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662};
663
Alan Cox452503f2005-10-21 19:01:32 -0400664struct ata_timing {
665 unsigned short mode; /* ATA mode */
666 unsigned short setup; /* t1 */
667 unsigned short act8b; /* t2 for 8-bit I/O */
668 unsigned short rec8b; /* t2i for 8-bit I/O */
669 unsigned short cyc8b; /* t0 for 8-bit I/O */
670 unsigned short active; /* t2 or tD */
671 unsigned short recover; /* t2i or tK */
672 unsigned short cycle; /* t0 */
673 unsigned short udma; /* t2CYCTYP/2 */
674};
675
676#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Tejun Heoe9c83912006-07-03 16:07:26 +0900678extern const unsigned long sata_deb_timing_normal[];
679extern const unsigned long sata_deb_timing_hotplug[];
680extern const unsigned long sata_deb_timing_long[];
681
Tejun Heodd5b06c2006-08-10 16:59:12 +0900682extern const struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900683extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900684
Tejun Heoe9c83912006-07-03 16:07:26 +0900685static inline const unsigned long *
686sata_ehc_deb_timing(struct ata_eh_context *ehc)
687{
688 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
689 return sata_deb_timing_hotplug;
690 else
691 return sata_deb_timing_normal;
692}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900693
Tejun Heodd5b06c2006-08-10 16:59:12 +0900694static inline int ata_port_is_dummy(struct ata_port *ap)
695{
696 return ap->ops == &ata_dummy_port_ops;
697}
698
Tejun Heo936fd732007-08-06 18:36:23 +0900699extern void sata_print_link_status(struct ata_link *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700extern void ata_port_probe(struct ata_port *);
701extern void __sata_phy_reset(struct ata_port *ap);
702extern void sata_phy_reset(struct ata_port *ap);
703extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo936fd732007-08-06 18:36:23 +0900704extern int sata_set_spd(struct ata_link *link);
705extern int sata_link_debounce(struct ata_link *link,
706 const unsigned long *params, unsigned long deadline);
707extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
708 unsigned long deadline);
Tejun Heod4b2bab2007-02-02 16:50:52 +0900709extern int ata_std_prereset(struct ata_port *ap, unsigned long deadline);
710extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes,
711 unsigned long deadline);
712extern int sata_port_hardreset(struct ata_port *ap, const unsigned long *timing,
713 unsigned long deadline);
714extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class,
715 unsigned long deadline);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900716extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717extern void ata_port_disable(struct ata_port *);
718extern void ata_std_ports(struct ata_ioports *ioaddr);
719#ifdef CONFIG_PCI
Tejun Heo1626aeb2007-05-04 12:43:58 +0200720extern int ata_pci_init_one (struct pci_dev *pdev,
721 const struct ata_port_info * const * ppi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722extern void ata_pci_remove_one (struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900723#ifdef CONFIG_PM
Tejun Heo3c5100c2006-07-26 16:58:33 +0900724extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
Tejun Heo553c4aa2006-12-26 19:39:50 +0900725extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900726extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
Jens Axboe9b847542006-01-06 09:28:07 +0100727extern int ata_pci_device_resume(struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900728#endif
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500729extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730#endif /* CONFIG_PCI */
Tejun Heof3187192007-04-17 23:44:07 +0900731extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +0900732extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
733 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heoecef7252007-04-17 23:44:06 +0900734extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +0900735extern int ata_host_register(struct ata_host *host,
736 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +0900737extern int ata_host_activate(struct ata_host *host, int irq,
738 irq_handler_t irq_handler, unsigned long irq_flags,
739 struct scsi_host_template *sht);
Tejun Heo0529c152007-01-20 16:00:26 +0900740extern void ata_host_detach(struct ata_host *host);
Jeff Garzikcca39742006-08-24 03:19:22 -0400741extern void ata_host_init(struct ata_host *, struct device *,
742 unsigned long, const struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -0500743extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
745extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Brian King80289162006-08-07 14:27:31 -0500746extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400747extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500748 struct ata_port_info *, struct Scsi_Host *);
749extern int ata_sas_port_init(struct ata_port *);
750extern int ata_sas_port_start(struct ata_port *ap);
751extern void ata_sas_port_stop(struct ata_port *ap);
752extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
753extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
754 struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo936fd732007-08-06 18:36:23 +0900756extern int sata_scr_valid(struct ata_link *link);
757extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
758extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
759extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
760extern int ata_link_online(struct ata_link *link);
761extern int ata_link_offline(struct ata_link *link);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900762#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -0400763extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
764extern void ata_host_resume(struct ata_host *host);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900765#endif
Jeff Garzik67846b32005-10-05 02:58:32 -0400766extern int ata_ratelimit(void);
Tejun Heod1adc1b2006-10-09 18:32:15 +0900767extern int ata_busy_sleep(struct ata_port *ap,
768 unsigned long timeout_pat, unsigned long timeout);
Tejun Heod4b2bab2007-02-02 16:50:52 +0900769extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
David Howells65f27f32006-11-22 14:55:48 +0000770extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
Tejun Heo86e45b62006-03-05 15:29:09 +0900771 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900772extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
773 unsigned long interval_msec,
774 unsigned long timeout_msec);
Akira Iguchia619f981b2007-01-26 16:28:18 +0900775extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
Jeff Garzik67846b32005-10-05 02:58:32 -0400776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777/*
778 * Default driver ops implementations
779 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400780extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Tejun Heo99771262007-07-16 14:29:38 +0900782extern void ata_tf_to_fis(const struct ata_taskfile *tf,
783 u8 pmp, int is_cmd, u8 *fis);
Jeff Garzik057ace52005-10-22 14:27:05 -0400784extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
786extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
787extern u8 ata_check_status(struct ata_port *ap);
788extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400789extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790extern int ata_port_start (struct ata_port *ap);
Alan Coxd92e74d2007-06-07 16:19:15 +0100791extern int ata_sff_port_start (struct ata_port *ap);
David Howells7d12e782006-10-05 14:55:46 +0100792extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900793extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
794 unsigned int buflen, int write_data);
795extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
796 unsigned int buflen, int write_data);
Alan Coxd26fc952007-07-06 19:13:52 -0400797extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600799extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900800extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
802 unsigned int buflen);
803extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
804 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400805extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +0000806extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +0900807extern void ata_id_string(const u16 *id, unsigned char *s,
808 unsigned int ofs, unsigned int len);
809extern void ata_id_c_string(const u16 *id, unsigned char *s,
810 unsigned int ofs, unsigned int len);
Alan10305f02007-02-20 18:01:59 +0000811extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
813extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100814extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815extern u8 ata_bmdma_status(struct ata_port *ap);
816extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900817extern void ata_bmdma_freeze(struct ata_port *ap);
818extern void ata_bmdma_thaw(struct ata_port *ap);
Tejun Heof5914a42006-05-31 18:27:48 +0900819extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900820 ata_reset_fn_t softreset,
821 ata_reset_fn_t hardreset,
822 ata_postreset_fn_t postreset);
823extern void ata_bmdma_error_handler(struct ata_port *ap);
824extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo9a1004d2006-05-31 18:27:52 +0900825extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
826 u8 status, int in_wq);
Tejun Heof686bcb2006-05-15 20:58:05 +0900827extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900828extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
829 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900830extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 void (*done)(struct scsi_cmnd *));
832extern int ata_std_bios_param(struct scsi_device *sdev,
833 struct block_device *bdev,
834 sector_t capacity, int geom[]);
835extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900836extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900837extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
838 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900839extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Alan04351822007-03-06 02:37:52 -0800840extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
Akira Iguchi83625002007-01-26 16:27:32 +0900841extern u8 ata_irq_on(struct ata_port *ap);
842extern u8 ata_dummy_irq_on(struct ata_port *ap);
843extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
844extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Alan Coxbe0d18d2007-03-06 02:37:56 -0800846extern int ata_cable_40wire(struct ata_port *ap);
847extern int ata_cable_80wire(struct ata_port *ap);
848extern int ata_cable_sata(struct ata_port *ap);
849extern int ata_cable_unknown(struct ata_port *ap);
850
Alan Cox452503f2005-10-21 19:01:32 -0400851/*
852 * Timing helpers
853 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000854
855extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400856extern int ata_timing_compute(struct ata_device *, unsigned short,
857 struct ata_timing *, int, int);
858extern void ata_timing_merge(const struct ata_timing *,
859 const struct ata_timing *, struct ata_timing *,
860 unsigned int);
861
862enum {
863 ATA_TIMING_SETUP = (1 << 0),
864 ATA_TIMING_ACT8B = (1 << 1),
865 ATA_TIMING_REC8B = (1 << 2),
866 ATA_TIMING_CYC8B = (1 << 3),
867 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
868 ATA_TIMING_CYC8B,
869 ATA_TIMING_ACTIVE = (1 << 4),
870 ATA_TIMING_RECOVER = (1 << 5),
871 ATA_TIMING_CYCLE = (1 << 6),
872 ATA_TIMING_UDMA = (1 << 7),
873 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
874 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
875 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
876 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
877};
878
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
880#ifdef CONFIG_PCI
881struct pci_bits {
882 unsigned int reg; /* PCI config register to read */
883 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
884 unsigned long mask;
885 unsigned long val;
886};
887
Tejun Heod583bc12007-07-04 18:02:07 +0900888extern int ata_pci_init_sff_host(struct ata_host *host);
Tejun Heo1626aeb2007-05-04 12:43:58 +0200889extern int ata_pci_init_bmdma(struct ata_host *host);
Tejun Heod583bc12007-07-04 18:02:07 +0900890extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
891 const struct ata_port_info * const * ppi,
892 struct ata_host **r_host);
Jeff Garzik057ace52005-10-22 14:27:05 -0400893extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Alan Coxa76b62c2007-03-09 09:34:07 -0500894extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895#endif /* CONFIG_PCI */
896
Tejun Heoece1d632006-04-02 18:51:53 +0900897/*
898 * EH
899 */
Tejun Heoece1d632006-04-02 18:51:53 +0900900extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900901
902extern void ata_port_schedule_eh(struct ata_port *ap);
903extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900904extern int ata_port_freeze(struct ata_port *ap);
905
906extern void ata_eh_freeze_port(struct ata_port *ap);
907extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900908
Tejun Heoece1d632006-04-02 18:51:53 +0900909extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
910extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
911
Tejun Heof5914a42006-05-31 18:27:48 +0900912extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
913 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
914 ata_postreset_fn_t postreset);
Tejun Heo022bdb02006-05-15 20:58:22 +0900915
Tejun Heo61440db2006-05-15 20:57:55 +0900916/*
917 * printk helpers
918 */
919#define ata_port_printk(ap, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900920 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900922#define ata_link_printk(link, lv, fmt, args...) \
923 printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args)
924
Tejun Heo61440db2006-05-15 20:57:55 +0900925#define ata_dev_printk(dev, lv, fmt, args...) \
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900926 printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, (dev)->devno , ##args)
Tejun Heo61440db2006-05-15 20:57:55 +0900927
928/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900929 * ata_eh_info helpers
930 */
Tejun Heob64bbc32007-07-16 14:29:39 +0900931extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
932extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
933extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
Tejun Heof3e81b12006-05-15 20:58:21 +0900934
Tejun Heof8f1e1c2007-07-16 14:29:40 +0900935static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
Tejun Heo084fe632006-05-31 18:28:03 +0900936{
Tejun Heof8f1e1c2007-07-16 14:29:40 +0900937 ehi->flags |= ATA_EHI_RESUME_LINK;
Tejun Heo084fe632006-05-31 18:28:03 +0900938 ehi->action |= ATA_EH_SOFTRESET;
939 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
940}
941
Tejun Heoc0b6c032006-07-03 16:07:26 +0900942static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
943{
Tejun Heof8f1e1c2007-07-16 14:29:40 +0900944 ata_ehi_schedule_probe(ehi);
945 ehi->flags |= ATA_EHI_HOTPLUGGED;
Tejun Heoc0b6c032006-07-03 16:07:26 +0900946 ehi->err_mask |= AC_ERR_ATA_BUS;
947}
948
Tejun Heof3e81b12006-05-15 20:58:21 +0900949/*
Tejun Heo61440db2006-05-15 20:57:55 +0900950 * qc helpers
951 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400952static inline int
953ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
954{
955 if (sg == &qc->pad_sgent)
956 return 1;
957 if (qc->pad_len)
958 return 0;
959 if (((sg - qc->__sg) + 1) == qc->n_elem)
960 return 1;
961 return 0;
962}
963
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400964static inline struct scatterlist *
Tejun Heocc1887f32006-02-20 23:48:38 +0900965ata_qc_first_sg(struct ata_queued_cmd *qc)
966{
967 if (qc->n_elem)
968 return qc->__sg;
969 if (qc->pad_len)
970 return &qc->pad_sgent;
971 return NULL;
972}
973
974static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400975ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
976{
977 if (sg == &qc->pad_sgent)
978 return NULL;
979 if (++sg - qc->__sg < qc->n_elem)
980 return sg;
Tejun Heocc1887f32006-02-20 23:48:38 +0900981 if (qc->pad_len)
982 return &qc->pad_sgent;
983 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400984}
985
986#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f32006-02-20 23:48:38 +0900987 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400988
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989static inline unsigned int ata_tag_valid(unsigned int tag)
990{
991 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
992}
993
Tejun Heo2ab7db12006-05-15 20:58:02 +0900994static inline unsigned int ata_tag_internal(unsigned int tag)
995{
996 return tag == ATA_MAX_QUEUE - 1;
997}
998
Tejun Heo5806db22006-06-24 20:30:19 +0900999/*
1000 * device helpers
1001 */
Tejun Heoe1211e32006-04-01 01:38:18 +09001002static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +09001003{
1004 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
1005}
1006
Tejun Heoe1211e32006-04-01 01:38:18 +09001007static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008{
Tejun Heoe1211e32006-04-01 01:38:18 +09001009 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
1010}
1011
Tejun Heo002c8052006-04-02 17:54:46 +09001012static inline unsigned int ata_class_absent(unsigned int class)
1013{
1014 return !ata_class_enabled(class) && !ata_class_disabled(class);
1015}
1016
Tejun Heoe1211e32006-04-01 01:38:18 +09001017static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1018{
1019 return ata_class_enabled(dev->class);
1020}
1021
1022static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1023{
1024 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025}
1026
Tejun Heo002c8052006-04-02 17:54:46 +09001027static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1028{
1029 return ata_class_absent(dev->class);
1030}
1031
Tejun Heo5806db22006-06-24 20:30:19 +09001032/*
Tejun Heof58229f2007-08-06 18:36:23 +09001033 * link helpers
Tejun Heo5806db22006-06-24 20:30:19 +09001034 */
Tejun Heof58229f2007-08-06 18:36:23 +09001035static inline int ata_link_max_devices(const struct ata_link *link)
Tejun Heo5806db22006-06-24 20:30:19 +09001036{
Tejun Heof58229f2007-08-06 18:36:23 +09001037 if (link->ap->flags & ATA_FLAG_SLAVE_POSS)
Tejun Heo5806db22006-06-24 20:30:19 +09001038 return 2;
1039 return 1;
1040}
1041
Tejun Heof58229f2007-08-06 18:36:23 +09001042#define ata_port_for_each_link(lk, ap) \
1043 for ((lk) = &(ap)->link; (lk); (lk) = NULL)
1044
1045#define ata_link_for_each_dev(dev, link) \
1046 for ((dev) = (link)->device; \
1047 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1048 (dev)++)
1049
1050#define ata_link_for_each_dev_reverse(dev, link) \
1051 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1052 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
Tejun Heo5806db22006-06-24 20:30:19 +09001053
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054static inline u8 ata_chk_status(struct ata_port *ap)
1055{
1056 return ap->ops->check_status(ap);
1057}
1058
Tejun Heo6d1245b2007-02-20 23:20:27 +09001059/**
1060 * ata_ncq_enabled - Test whether NCQ is enabled
1061 * @dev: ATA device to test for
1062 *
1063 * LOCKING:
1064 * spin_lock_irqsave(host lock)
1065 *
1066 * RETURNS:
1067 * 1 if NCQ is enabled for @dev, 0 otherwise.
1068 */
1069static inline int ata_ncq_enabled(struct ata_device *dev)
1070{
1071 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1072 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1073}
Edward Falk0baab862005-06-02 18:17:13 -04001074
1075/**
1076 * ata_pause - Flush writes and pause 400 nanoseconds.
1077 * @ap: Port to wait for.
1078 *
1079 * LOCKING:
1080 * Inherited from caller.
1081 */
1082
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083static inline void ata_pause(struct ata_port *ap)
1084{
1085 ata_altstatus(ap);
1086 ndelay(400);
1087}
1088
Edward Falk0baab862005-06-02 18:17:13 -04001089
1090/**
1091 * ata_busy_wait - Wait for a port status register
1092 * @ap: Port to wait for.
Alan07777212007-01-31 17:47:24 +00001093 * @bits: bits that must be clear
1094 * @max: number of 10uS waits to perform
Edward Falk0baab862005-06-02 18:17:13 -04001095 *
1096 * Waits up to max*10 microseconds for the selected bits in the port's
1097 * status register to be cleared.
1098 * Returns final value of status register.
1099 *
1100 * LOCKING:
1101 * Inherited from caller.
1102 */
1103
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1105 unsigned int max)
1106{
1107 u8 status;
1108
1109 do {
1110 udelay(10);
1111 status = ata_chk_status(ap);
1112 max--;
Tejun Heod1adc1b2006-10-09 18:32:15 +09001113 } while (status != 0xff && (status & bits) && (max > 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114
1115 return status;
1116}
1117
Edward Falk0baab862005-06-02 18:17:13 -04001118
1119/**
1120 * ata_wait_idle - Wait for a port to be idle.
1121 * @ap: Port to wait for.
1122 *
1123 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1124 * Returns final value of status register.
1125 *
1126 * LOCKING:
1127 * Inherited from caller.
1128 */
1129
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130static inline u8 ata_wait_idle(struct ata_port *ap)
1131{
1132 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1133
Tejun Heo55f39522007-06-25 21:31:05 +09001134 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1135 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1136 status, ap->ioaddr.status_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
1138 return status;
1139}
1140
1141static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1142{
1143 qc->tf.ctl |= ATA_NIEN;
1144}
1145
Tejun Heof69499f2006-05-15 20:58:03 +09001146static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1147 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148{
1149 if (likely(ata_tag_valid(tag)))
1150 return &ap->qcmd[tag];
1151 return NULL;
1152}
1153
Tejun Heof69499f2006-05-15 20:58:03 +09001154static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1155 unsigned int tag)
1156{
1157 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1158
1159 if (unlikely(!qc) || !ap->ops->error_handler)
1160 return qc;
1161
1162 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1163 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1164 return qc;
1165
1166 return NULL;
1167}
1168
Tejun Heo3373efd2006-05-15 20:57:53 +09001169static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170{
1171 memset(tf, 0, sizeof(*tf));
1172
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001173 tf->ctl = dev->link->ap->ctl;
Tejun Heo3373efd2006-05-15 20:57:53 +09001174 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 tf->device = ATA_DEVICE_OBS;
1176 else
1177 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1178}
1179
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001180static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1181{
Tejun Heo501e0c502007-01-17 11:34:02 +09001182 qc->dma_dir = DMA_NONE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001183 qc->__sg = NULL;
1184 qc->flags = 0;
Tejun Heo726f0782007-01-03 17:30:39 +09001185 qc->cursg = qc->cursg_ofs = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001186 qc->nbytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001187 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001188 qc->err_mask = 0;
Brian Kingd0f29482007-01-17 12:32:28 -06001189 qc->pad_len = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001190 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001191
Tejun Heo3373efd2006-05-15 20:57:53 +09001192 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001193
1194 /* init result_tf such that it indicates normal completion */
1195 qc->result_tf.command = ATA_DRDY;
1196 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001197}
1198
Jeff Garzik057ace52005-10-22 14:27:05 -04001199static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200{
1201 return ata_id_wcache_enabled(dev->id) ||
1202 ata_id_has_flush(dev->id) ||
1203 ata_id_has_flush_ext(dev->id);
1204}
1205
Jeff Garzika7dac442005-10-30 04:44:42 -05001206static inline unsigned int ac_err_mask(u8 status)
1207{
Albert Lee3655d1d2006-05-19 11:43:04 +08001208 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001209 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001210 if (status & (ATA_ERR | ATA_DF))
1211 return AC_ERR_DEV;
1212 return 0;
1213}
1214
1215static inline unsigned int __ac_err_mask(u8 status)
1216{
1217 unsigned int mask = ac_err_mask(status);
1218 if (mask == 0)
1219 return AC_ERR_OTHER;
1220 return mask;
1221}
1222
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001223static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1224{
1225 ap->pad_dma = 0;
Tejun Heof0d36ef2007-01-20 16:00:28 +09001226 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1227 &ap->pad_dma, GFP_KERNEL);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001228 return (ap->pad == NULL) ? -ENOMEM : 0;
1229}
1230
1231static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1232{
Tejun Heof0d36ef2007-01-20 16:00:28 +09001233 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001234}
1235
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001236static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1237{
Tejun Heo49114872007-04-17 23:44:06 +09001238 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001239}
1240
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241#endif /* __LINUX_LIBATA_H__ */