blob: 7c14a52079d5ef6e98e033ee986972edf3fa8c41 [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,
119 ATA_MAX_PORTS = 8,
120 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900121 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900122 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900123 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 ATA_MAX_BUS = 2,
125 ATA_DEF_BUSY_WAIT = 10000,
126 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
127
128 ATA_SHT_EMULATED = 1,
129 ATA_SHT_CMD_PER_LUN = 1,
130 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400131 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900134 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
135 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400136 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900137 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900138 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heoea1dd4e2006-04-02 18:51:53 +0900139 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900140
Tejun Heoe5c9e082006-09-30 19:44:39 +0900141 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
Tejun Heo33435712006-10-19 14:44:53 +0900142 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
Tejun Heoe5c9e082006-09-30 19:44:39 +0900143 ATA_DFLAG_SUSPENDED = (1 << 10), /* device suspended */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900144 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Tejun Heoabdda732006-05-31 18:27:29 +0900146 ATA_DFLAG_DETACH = (1 << 16),
147 ATA_DFLAG_DETACHED = (1 << 17),
148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 ATA_DEV_UNKNOWN = 0, /* unknown device */
150 ATA_DEV_ATA = 1, /* ATA device */
151 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
152 ATA_DEV_ATAPI = 3, /* ATAPI device */
153 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
154 ATA_DEV_NONE = 5, /* no device */
155
156 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900157 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900159 ATA_FLAG_SATA = (1 << 1),
160 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
161 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
162 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
163 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
164 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
165 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
166 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900167 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
168 * doesn't handle PIO interrupts */
169 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Tejun Heoabdda732006-05-31 18:27:29 +0900170 ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
171 ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H
172 * Register FIS clearing BSY */
Tejun Heo7395acb2006-05-31 18:27:25 +0900173 ATA_FLAG_DEBUGMSG = (1 << 13),
Tejun Heo800b3992006-12-03 21:34:13 +0900174 ATA_FLAG_SETXFER_POLLING= (1 << 14), /* use polling for SETXFER */
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900175 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800176 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Jens Axboe9b847542006-01-06 09:28:07 +0100177
Tejun Heob51e9e52006-06-29 01:29:30 +0900178 /* The following flag belongs to ap->pflags but is kept in
179 * ap->flags because it's referenced in many LLDs and will be
180 * removed in not-too-distant future.
181 */
182 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900183
Tejun Heob51e9e52006-06-29 01:29:30 +0900184 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000185
Tejun Heob51e9e52006-06-29 01:29:30 +0900186 /* struct ata_port pflags */
187 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
188 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
189 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
190 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
191 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
192 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
193 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
194
195 ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
196 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900197 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heodde44582006-02-02 00:56:10 +0900198
Tejun Heo949b38a2006-04-02 18:51:52 +0900199 /* struct ata_queued_cmd flags */
200 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
201 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
202 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
Tejun Heo27197362006-04-02 18:51:53 +0900204 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900205 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
206
Tejun Heo9ec957f2006-05-15 20:57:58 +0900207 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
208 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
209 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100211 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400212 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900213 ATA_HOST_STARTED = (1 << 1), /* Host started */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000216 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
217 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900218 ATA_TMOUT_INTERNAL = 30 * HZ,
219 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221 /* ATA bus states */
222 BUS_UNKNOWN = 0,
223 BUS_DMA = 1,
224 BUS_IDLE = 2,
225 BUS_NOINTR = 3,
226 BUS_NODATA = 4,
227 BUS_TIMER = 5,
228 BUS_PIO = 6,
229 BUS_EDD = 7,
230 BUS_IDENTIFY = 8,
231 BUS_PACKET = 9,
232
233 /* SATA port states */
234 PORT_UNKNOWN = 0,
235 PORT_ENABLED = 1,
236 PORT_DISABLED = 2,
237
238 /* encoding various smaller bitmaps into a single
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900239 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 */
Alan Coxb352e572006-08-10 18:52:12 +0100241 ATA_BITS_PIO = 7,
242 ATA_BITS_MWDMA = 5,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900243 ATA_BITS_UDMA = 8,
244
245 ATA_SHIFT_PIO = 0,
246 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
247 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
248
249 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
250 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
251 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400252
253 /* size of buffer to pad xfers ending on unaligned boundaries */
254 ATA_DMA_PAD_SZ = 4,
255 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Tejun Heo949b38a2006-04-02 18:51:52 +0900256
257 /* masks for port functions */
Alan Cox47a86592005-10-04 08:09:19 -0400258 ATA_PORT_PRIMARY = (1 << 0),
259 ATA_PORT_SECONDARY = (1 << 1),
Tejun Heo14d2bac2006-04-02 17:54:46 +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),
Tejun Heo02670bf2006-07-03 16:07:26 +0900271 ATA_EH_SUSPEND = (1 << 3),
272 ATA_EH_RESUME = (1 << 4),
273 ATA_EH_PM_FREEZE = (1 << 5),
Tejun Heo9be1e972006-05-15 20:58:17 +0900274
275 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heo02670bf2006-07-03 16:07:26 +0900276 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
277 ATA_EH_RESUME | ATA_EH_PM_FREEZE,
Tejun Heo9be1e972006-05-15 20:58:17 +0900278
Tejun Heof3e81b12006-05-15 20:58:21 +0900279 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900280 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo13abf502006-07-10 23:18:46 +0900281 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900282 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
283 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900284
285 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
Tejun Heoefdaedc2006-11-01 18:38:52 +0900286 ATA_EHI_PRINTINFO = (1 << 17), /* print configuration info */
Tejun Heobaa1e782006-11-01 18:39:27 +0900287 ATA_EHI_SETMODE = (1 << 18), /* configure transfer mode */
288 ATA_EHI_POST_SETMODE = (1 << 19), /* revaildating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900289
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_RESET_TRIES = 3,
298 ATA_EH_DEV_TRIES = 3,
Tejun Heof5914a42006-05-31 18:27:48 +0900299
300 /* Drive spinup time (time from power-on to the first D2H FIS)
301 * in msecs - 8s currently. Failing to get ready in this time
302 * isn't critical. It will result in reset failure for
303 * controllers which can't wait for the first D2H FIS. libata
304 * will retry, so it just has to be long enough to spin up
305 * most devices.
306 */
307 ATA_SPINUP_WAIT = 8000,
Jeff Garzikf20b16f2006-12-11 11:14:06 -0500308
Alan Cox93590852006-09-12 16:55:12 +0100309 /* Horkage types. May be set by libata or controller on drives
310 (some horkage may be drive/controller pair dependant */
311
312 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700313 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
314 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800315 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Albert Lee6f23a312007-04-02 11:39:25 +0800316 ATA_HORKAGE_DMA_RW_ONLY = (1 << 4), /* ATAPI DMA for RW only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317};
318
Albert Lee14be71f2005-09-27 17:36:35 +0800319enum hsm_task_states {
Albert Leec56b14d2005-09-30 19:07:39 +0800320 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800321 HSM_ST_FIRST, /* (waiting the device to)
322 write CDB or first data block */
Albert Leec56b14d2005-09-30 19:07:39 +0800323 HSM_ST, /* (waiting the device to) transfer data */
324 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d2005-09-30 19:07:39 +0800325 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326};
327
Jeff Garzika7dac442005-10-30 04:44:42 -0500328enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900329 AC_ERR_DEV = (1 << 0), /* device reported error */
330 AC_ERR_HSM = (1 << 1), /* host state machine violation */
331 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
332 AC_ERR_MEDIA = (1 << 3), /* media error */
333 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
334 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
335 AC_ERR_SYSTEM = (1 << 6), /* system error */
336 AC_ERR_INVALID = (1 << 7), /* invalid argument */
337 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900338 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Jeff Garzika7dac442005-10-30 04:44:42 -0500339};
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341/* forward declarations */
342struct scsi_device;
343struct ata_port_operations;
344struct ata_port;
345struct ata_queued_cmd;
346
347/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900348typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heof5914a42006-05-31 18:27:48 +0900349typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
350typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
351typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
353struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900354 void __iomem *cmd_addr;
355 void __iomem *data_addr;
356 void __iomem *error_addr;
357 void __iomem *feature_addr;
358 void __iomem *nsect_addr;
359 void __iomem *lbal_addr;
360 void __iomem *lbam_addr;
361 void __iomem *lbah_addr;
362 void __iomem *device_addr;
363 void __iomem *status_addr;
364 void __iomem *command_addr;
365 void __iomem *altstatus_addr;
366 void __iomem *ctl_addr;
367 void __iomem *bmdma_addr;
368 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369};
370
Jeff Garzikcca39742006-08-24 03:19:22 -0400371struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 spinlock_t lock;
373 struct device *dev;
374 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900375 unsigned long irq2;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900376 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 unsigned int n_ports;
378 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400379 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100380 unsigned long flags;
Alan032af1c2007-03-01 17:36:46 +0000381 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900382 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383};
384
385struct ata_queued_cmd {
386 struct ata_port *ap;
387 struct ata_device *dev;
388
389 struct scsi_cmnd *scsicmd;
390 void (*scsidone)(struct scsi_cmnd *);
391
392 struct ata_taskfile tf;
393 u8 cdb[ATAPI_CDB_LEN];
394
395 unsigned long flags; /* ATA_QCFLAG_xxx */
396 unsigned int tag;
397 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400398 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
400 int dma_dir;
401
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400402 unsigned int pad_len;
Mark Lord5a5dbd12007-03-16 10:22:26 -0400403 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 unsigned int nbytes;
406 unsigned int curbytes;
407
408 unsigned int cursg;
409 unsigned int cursg_ofs;
410
411 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400412 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 void *buf_virt;
414
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400415 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
416 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
Albert Leea22e2eb2005-12-05 15:38:02 +0800418 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900419 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 ata_qc_cb_t complete_fn;
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 void *private_data;
423};
424
Jeff Garzikcca39742006-08-24 03:19:22 -0400425struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 unsigned long unhandled_irq;
427 unsigned long idle_irq;
428 unsigned long rw_reqbuf;
429};
430
Tejun Heo0c247c52006-05-15 20:58:19 +0900431struct ata_ering_entry {
432 int is_io;
433 unsigned int err_mask;
434 u64 timestamp;
435};
436
437struct ata_ering {
438 int cursor;
439 struct ata_ering_entry ring[ATA_ERING_SIZE];
440};
441
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442struct ata_device {
Tejun Heo38d87232006-05-15 20:57:51 +0900443 struct ata_port *ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 unsigned int devno; /* 0 or 1 */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900445 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900446 struct scsi_device *sdev; /* attached SCSI device */
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;
Alan Cox93590852006-09-12 16:55:12 +0100474 unsigned int horkage; /* List of broken features */
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700475#ifdef CONFIG_SATA_ACPI
476 /* ACPI objects info */
477 acpi_handle obj_handle;
478#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479};
480
Tejun Heo72fa4b72006-05-31 18:27:32 +0900481/* Offset into struct ata_device. Fields above it are maintained
482 * acress device init. Fields below are zeroed.
483 */
484#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
485
Tejun Heof3e81b12006-05-15 20:58:21 +0900486struct ata_eh_info {
487 struct ata_device *dev; /* offending device */
488 u32 serror; /* SError from LLDD */
489 unsigned int err_mask; /* port-wide err_mask */
490 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900491 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900492 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900493
494 unsigned long hotplug_timestamp;
495 unsigned int probe_mask;
496
Tejun Heof3e81b12006-05-15 20:58:21 +0900497 char desc[ATA_EH_DESC_LEN];
498 int desc_len;
499};
500
501struct ata_eh_context {
502 struct ata_eh_info i;
503 int tries[ATA_MAX_DEVICES];
Tejun Heoabdda732006-05-31 18:27:29 +0900504 unsigned int classes[ATA_MAX_DEVICES];
505 unsigned int did_probe_mask;
Tejun Heof3e81b12006-05-15 20:58:21 +0900506};
507
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400509 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400510 const struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400511 spinlock_t *lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 unsigned long flags; /* ATA_FLAG_xxx */
Tejun Heob51e9e52006-06-29 01:29:30 +0900513 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900514 unsigned int print_id; /* user visible unique port ID */
515 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
517 struct ata_prd *prd; /* our SG list */
518 dma_addr_t prd_dma; /* and its DMA mapping */
519
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400520 void *pad; /* array of DMA pad buffers */
521 dma_addr_t pad_dma;
522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
524
525 u8 ctl; /* cache of ATA control register */
526 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 unsigned int pio_mask;
528 unsigned int mwdma_mask;
529 unsigned int udma_mask;
530 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Tejun Heo5a04bf42006-05-31 18:27:38 +0900531 unsigned int hw_sata_spd_limit;
Tejun Heo1c3fae42006-04-02 20:53:28 +0900532 unsigned int sata_spd_limit; /* SATA PHY speed limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
Jeff Garzikcca39742006-08-24 03:19:22 -0400534 /* record runtime error info, protected by host lock */
Tejun Heof3e81b12006-05-15 20:58:21 +0900535 struct ata_eh_info eh_info;
536 /* EH context owned by EH */
537 struct ata_eh_context eh_context;
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 struct ata_device device[ATA_MAX_DEVICES];
540
541 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900542 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900543 unsigned int qc_active;
544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 unsigned int active_tag;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900546 u32 sactive;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Jeff Garzikcca39742006-08-24 03:19:22 -0400548 struct ata_port_stats stats;
549 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600550 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
David Howells65f27f32006-11-22 14:55:48 +0000552 void *port_task_data;
David Howells52bad642006-11-22 14:54:01 +0000553 struct delayed_work port_task;
554 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400555 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900556
Albert Lee14be71f2005-09-27 17:36:35 +0800557 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Randy Dunlapbfd60572006-01-17 19:34:42 -0500559 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900560 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900561 wait_queue_head_t eh_wait_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500562
Tejun Heo500530f2006-07-03 16:07:27 +0900563 pm_message_t pm_mesg;
564 int *pm_result;
565
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900567
568 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569};
570
571struct ata_port_operations {
572 void (*port_disable) (struct ata_port *);
573
Alancd0d3bb2007-03-02 00:56:15 +0000574 void (*dev_config) (struct ata_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
576 void (*set_piomode) (struct ata_port *, struct ata_device *);
577 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Coxa76b62c2007-03-09 09:34:07 -0500578 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
Jeff Garzik057ace52005-10-22 14:27:05 -0400580 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
582
Jeff Garzik057ace52005-10-22 14:27:05 -0400583 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 u8 (*check_status)(struct ata_port *ap);
585 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 void (*dev_select)(struct ata_port *ap, unsigned int device);
587
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900588 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Alanb229a7b2007-01-24 11:47:07 +0000589 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 void (*post_set_mode) (struct ata_port *ap);
592
Alan Coxbe0d18d2007-03-06 02:37:56 -0800593 int (*cable_detect) (struct ata_port *ap);
594
Alanb229a7b2007-01-24 11:47:07 +0000595 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
597 void (*bmdma_setup) (struct ata_queued_cmd *qc);
598 void (*bmdma_start) (struct ata_queued_cmd *qc);
599
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100600 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900603 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
Tejun Heo9ec957f2006-05-15 20:57:58 +0900605 /* Error handlers. ->error_handler overrides ->eng_timeout and
606 * indicates that new-style EH is in place.
607 */
608 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
609
610 void (*freeze) (struct ata_port *ap);
611 void (*thaw) (struct ata_port *ap);
612 void (*error_handler) (struct ata_port *ap);
613 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
David Howells7d12e782006-10-05 14:55:46 +0100615 irq_handler_t irq_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 void (*irq_clear) (struct ata_port *);
Akira Iguchi836250062007-01-26 16:27:32 +0900617 u8 (*irq_on) (struct ata_port *);
618 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
621 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
622 u32 val);
623
Tejun Heo500530f2006-07-03 16:07:27 +0900624 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
625 int (*port_resume) (struct ata_port *ap);
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 int (*port_start) (struct ata_port *ap);
628 void (*port_stop) (struct ata_port *ap);
629
Jeff Garzikcca39742006-08-24 03:19:22 -0400630 void (*host_stop) (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Alan Coxb73fc892005-08-26 16:03:19 +0100632 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 u8 (*bmdma_status) (struct ata_port *ap);
634};
635
636struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100637 struct scsi_host_template *sht;
Jeff Garzikcca39742006-08-24 03:19:22 -0400638 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 unsigned long pio_mask;
640 unsigned long mwdma_mask;
641 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400642 const struct ata_port_operations *port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900643 irq_handler_t irq_handler;
Alan Coxe99f8b52005-11-08 14:09:44 +0000644 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645};
646
Alan Cox452503f2005-10-21 19:01:32 -0400647struct ata_timing {
648 unsigned short mode; /* ATA mode */
649 unsigned short setup; /* t1 */
650 unsigned short act8b; /* t2 for 8-bit I/O */
651 unsigned short rec8b; /* t2i for 8-bit I/O */
652 unsigned short cyc8b; /* t0 for 8-bit I/O */
653 unsigned short active; /* t2 or tD */
654 unsigned short recover; /* t2i or tK */
655 unsigned short cycle; /* t0 */
656 unsigned short udma; /* t2CYCTYP/2 */
657};
658
659#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Tejun Heoe9c83912006-07-03 16:07:26 +0900661extern const unsigned long sata_deb_timing_normal[];
662extern const unsigned long sata_deb_timing_hotplug[];
663extern const unsigned long sata_deb_timing_long[];
664
Tejun Heodd5b06c2006-08-10 16:59:12 +0900665extern const struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900666extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900667
Tejun Heoe9c83912006-07-03 16:07:26 +0900668static inline const unsigned long *
669sata_ehc_deb_timing(struct ata_eh_context *ehc)
670{
671 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
672 return sata_deb_timing_hotplug;
673 else
674 return sata_deb_timing_normal;
675}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900676
Tejun Heodd5b06c2006-08-10 16:59:12 +0900677static inline int ata_port_is_dummy(struct ata_port *ap)
678{
679 return ap->ops == &ata_dummy_port_ops;
680}
681
Jeff Garzik43727fb2007-02-25 16:50:52 -0500682extern void sata_print_link_status(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683extern void ata_port_probe(struct ata_port *);
684extern void __sata_phy_reset(struct ata_port *ap);
685extern void sata_phy_reset(struct ata_port *ap);
686extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo3c567b72006-05-15 20:57:23 +0900687extern int sata_set_spd(struct ata_port *ap);
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900688extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
689extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
Tejun Heof5914a42006-05-31 18:27:48 +0900690extern int ata_std_prereset(struct ata_port *ap);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900691extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
Tejun Heob6103f62006-11-01 17:59:53 +0900692extern int sata_port_hardreset(struct ata_port *ap,
693 const unsigned long *timing);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900694extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900695extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696extern void ata_port_disable(struct ata_port *);
697extern void ata_std_ports(struct ata_ioports *ioaddr);
698#ifdef CONFIG_PCI
699extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
700 unsigned int n_ports);
701extern void ata_pci_remove_one (struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900702#ifdef CONFIG_PM
Tejun Heo3c5100c2006-07-26 16:58:33 +0900703extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
Tejun Heo553c4aa2006-12-26 19:39:50 +0900704extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900705extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
Jens Axboe9b847542006-01-06 09:28:07 +0100706extern int ata_pci_device_resume(struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900707#endif
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500708extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709#endif /* CONFIG_PCI */
Tejun Heof3187192007-04-17 23:44:07 +0900710extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +0900711extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
712 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heoecef7252007-04-17 23:44:06 +0900713extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +0900714extern int ata_host_register(struct ata_host *host,
715 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +0900716extern int ata_host_activate(struct ata_host *host, int irq,
717 irq_handler_t irq_handler, unsigned long irq_flags,
718 struct scsi_host_template *sht);
Tejun Heo0529c152007-01-20 16:00:26 +0900719extern void ata_host_detach(struct ata_host *host);
Jeff Garzikcca39742006-08-24 03:19:22 -0400720extern void ata_host_init(struct ata_host *, struct device *,
721 unsigned long, const struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -0500722extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
724extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Brian King80289162006-08-07 14:27:31 -0500725extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400726extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500727 struct ata_port_info *, struct Scsi_Host *);
728extern int ata_sas_port_init(struct ata_port *);
729extern int ata_sas_port_start(struct ata_port *ap);
730extern void ata_sas_port_stop(struct ata_port *ap);
731extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
732extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
733 struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo34bf2172006-05-15 20:57:46 +0900735extern int sata_scr_valid(struct ata_port *ap);
736extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
737extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
738extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
739extern int ata_port_online(struct ata_port *ap);
740extern int ata_port_offline(struct ata_port *ap);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900741#ifdef CONFIG_PM
Jens Axboe9b847542006-01-06 09:28:07 +0100742extern int ata_scsi_device_resume(struct scsi_device *);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900743extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
Jeff Garzikcca39742006-08-24 03:19:22 -0400744extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
745extern void ata_host_resume(struct ata_host *host);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900746#endif
Jeff Garzik67846b32005-10-05 02:58:32 -0400747extern int ata_ratelimit(void);
Tejun Heod1adc1b2006-10-09 18:32:15 +0900748extern int ata_busy_sleep(struct ata_port *ap,
749 unsigned long timeout_pat, unsigned long timeout);
David Howells65f27f32006-11-22 14:55:48 +0000750extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
Tejun Heo86e45b62006-03-05 15:29:09 +0900751 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900752extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
753 unsigned long interval_msec,
754 unsigned long timeout_msec);
Akira Iguchia619f981b2007-01-26 16:28:18 +0900755extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
Jeff Garzik67846b32005-10-05 02:58:32 -0400756
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757/*
758 * Default driver ops implementations
759 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400760extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400762extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
763extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
765extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
766extern u8 ata_check_status(struct ata_port *ap);
767extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400768extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769extern int ata_port_start (struct ata_port *ap);
David Howells7d12e782006-10-05 14:55:46 +0100770extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900771extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
772 unsigned int buflen, int write_data);
773extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
774 unsigned int buflen, int write_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600776extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900777extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
779 unsigned int buflen);
780extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
781 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400782extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +0000783extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +0900784extern void ata_id_string(const u16 *id, unsigned char *s,
785 unsigned int ofs, unsigned int len);
786extern void ata_id_c_string(const u16 *id, unsigned char *s,
787 unsigned int ofs, unsigned int len);
Alan10305f02007-02-20 18:01:59 +0000788extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
Alan Cox6919a0a2006-10-27 19:08:46 -0700789extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
791extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100792extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793extern u8 ata_bmdma_status(struct ata_port *ap);
794extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900795extern void ata_bmdma_freeze(struct ata_port *ap);
796extern void ata_bmdma_thaw(struct ata_port *ap);
Tejun Heof5914a42006-05-31 18:27:48 +0900797extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900798 ata_reset_fn_t softreset,
799 ata_reset_fn_t hardreset,
800 ata_postreset_fn_t postreset);
801extern void ata_bmdma_error_handler(struct ata_port *ap);
802extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo9a1004d2006-05-31 18:27:52 +0900803extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
804 u8 status, int in_wq);
Tejun Heof686bcb2006-05-15 20:58:05 +0900805extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900806extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
807 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900808extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 void (*done)(struct scsi_cmnd *));
810extern int ata_std_bios_param(struct scsi_device *sdev,
811 struct block_device *bdev,
812 sector_t capacity, int geom[]);
813extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900814extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900815extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
816 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900817extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Alan04351822007-03-06 02:37:52 -0800818extern int ata_do_set_mode(struct ata_port *ap, struct ata_device **r_failed_dev);
Akira Iguchi836250062007-01-26 16:27:32 +0900819extern u8 ata_irq_on(struct ata_port *ap);
820extern u8 ata_dummy_irq_on(struct ata_port *ap);
821extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
822extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Alan Coxbe0d18d2007-03-06 02:37:56 -0800824extern int ata_cable_40wire(struct ata_port *ap);
825extern int ata_cable_80wire(struct ata_port *ap);
826extern int ata_cable_sata(struct ata_port *ap);
827extern int ata_cable_unknown(struct ata_port *ap);
828
Alan Cox452503f2005-10-21 19:01:32 -0400829/*
830 * Timing helpers
831 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000832
833extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400834extern int ata_timing_compute(struct ata_device *, unsigned short,
835 struct ata_timing *, int, int);
836extern void ata_timing_merge(const struct ata_timing *,
837 const struct ata_timing *, struct ata_timing *,
838 unsigned int);
839
840enum {
841 ATA_TIMING_SETUP = (1 << 0),
842 ATA_TIMING_ACT8B = (1 << 1),
843 ATA_TIMING_REC8B = (1 << 2),
844 ATA_TIMING_CYC8B = (1 << 3),
845 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
846 ATA_TIMING_CYC8B,
847 ATA_TIMING_ACTIVE = (1 << 4),
848 ATA_TIMING_RECOVER = (1 << 5),
849 ATA_TIMING_CYCLE = (1 << 6),
850 ATA_TIMING_UDMA = (1 << 7),
851 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
852 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
853 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
854 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
855};
856
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
858#ifdef CONFIG_PCI
859struct pci_bits {
860 unsigned int reg; /* PCI config register to read */
861 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
862 unsigned long mask;
863 unsigned long val;
864};
865
Tejun Heod491b272007-04-17 23:44:07 +0900866extern int ata_pci_init_native_host(struct ata_host *host,
867 unsigned int port_mask);
Tejun Heo21b0ad42007-04-17 23:44:07 +0900868extern int ata_pci_prepare_native_host(struct pci_dev *pdev,
869 const struct ata_port_info * const * ppi,
870 int n_ports, struct ata_host **r_host);
Jeff Garzik057ace52005-10-22 14:27:05 -0400871extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Alan Coxa76b62c2007-03-09 09:34:07 -0500872extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873#endif /* CONFIG_PCI */
874
Tejun Heoece1d632006-04-02 18:51:53 +0900875/*
876 * EH
877 */
Tejun Heoece1d632006-04-02 18:51:53 +0900878extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900879
880extern void ata_port_schedule_eh(struct ata_port *ap);
881extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900882extern int ata_port_freeze(struct ata_port *ap);
883
884extern void ata_eh_freeze_port(struct ata_port *ap);
885extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900886
Tejun Heoece1d632006-04-02 18:51:53 +0900887extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
888extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
889
Tejun Heof5914a42006-05-31 18:27:48 +0900890extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
891 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
892 ata_postreset_fn_t postreset);
Tejun Heo022bdb02006-05-15 20:58:22 +0900893
Tejun Heo61440db2006-05-15 20:57:55 +0900894/*
895 * printk helpers
896 */
897#define ata_port_printk(ap, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900898 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Tejun Heo61440db2006-05-15 20:57:55 +0900900#define ata_dev_printk(dev, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900901 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
Tejun Heo61440db2006-05-15 20:57:55 +0900902
903/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900904 * ata_eh_info helpers
905 */
906#define ata_ehi_push_desc(ehi, fmt, args...) do { \
907 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
908 ATA_EH_DESC_LEN - (ehi)->desc_len, \
909 fmt , ##args); \
910} while (0)
911
912#define ata_ehi_clear_desc(ehi) do { \
913 (ehi)->desc[0] = '\0'; \
914 (ehi)->desc_len = 0; \
915} while (0)
916
Tejun Heoc0b6c032006-07-03 16:07:26 +0900917static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
Tejun Heo084fe632006-05-31 18:28:03 +0900918{
919 if (ehi->flags & ATA_EHI_HOTPLUGGED)
920 return;
921
Tejun Heo28324302006-07-03 16:07:26 +0900922 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
Tejun Heo084fe632006-05-31 18:28:03 +0900923 ehi->hotplug_timestamp = jiffies;
924
Tejun Heo084fe632006-05-31 18:28:03 +0900925 ehi->action |= ATA_EH_SOFTRESET;
926 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
927}
928
Tejun Heoc0b6c032006-07-03 16:07:26 +0900929static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
930{
931 __ata_ehi_hotplugged(ehi);
932 ehi->err_mask |= AC_ERR_ATA_BUS;
933}
934
Tejun Heof3e81b12006-05-15 20:58:21 +0900935/*
Tejun Heo61440db2006-05-15 20:57:55 +0900936 * qc helpers
937 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400938static inline int
939ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
940{
941 if (sg == &qc->pad_sgent)
942 return 1;
943 if (qc->pad_len)
944 return 0;
945 if (((sg - qc->__sg) + 1) == qc->n_elem)
946 return 1;
947 return 0;
948}
949
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400950static inline struct scatterlist *
Tejun Heocc1887f2006-02-20 23:48:38 +0900951ata_qc_first_sg(struct ata_queued_cmd *qc)
952{
953 if (qc->n_elem)
954 return qc->__sg;
955 if (qc->pad_len)
956 return &qc->pad_sgent;
957 return NULL;
958}
959
960static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400961ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
962{
963 if (sg == &qc->pad_sgent)
964 return NULL;
965 if (++sg - qc->__sg < qc->n_elem)
966 return sg;
Tejun Heocc1887f2006-02-20 23:48:38 +0900967 if (qc->pad_len)
968 return &qc->pad_sgent;
969 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400970}
971
972#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f2006-02-20 23:48:38 +0900973 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400974
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975static inline unsigned int ata_tag_valid(unsigned int tag)
976{
977 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
978}
979
Tejun Heo2ab7db12006-05-15 20:58:02 +0900980static inline unsigned int ata_tag_internal(unsigned int tag)
981{
982 return tag == ATA_MAX_QUEUE - 1;
983}
984
Tejun Heo5806db22006-06-24 20:30:19 +0900985/*
986 * device helpers
987 */
Tejun Heoe1211e32006-04-01 01:38:18 +0900988static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +0900989{
990 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
991}
992
Tejun Heoe1211e32006-04-01 01:38:18 +0900993static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994{
Tejun Heoe1211e32006-04-01 01:38:18 +0900995 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
996}
997
Tejun Heo002c8052006-04-02 17:54:46 +0900998static inline unsigned int ata_class_absent(unsigned int class)
999{
1000 return !ata_class_enabled(class) && !ata_class_disabled(class);
1001}
1002
Tejun Heoe1211e32006-04-01 01:38:18 +09001003static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1004{
1005 return ata_class_enabled(dev->class);
1006}
1007
1008static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1009{
1010 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011}
1012
Tejun Heo002c8052006-04-02 17:54:46 +09001013static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1014{
1015 return ata_class_absent(dev->class);
1016}
1017
Tejun Heo02670bf2006-07-03 16:07:26 +09001018static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1019{
1020 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1021}
1022
Tejun Heo5806db22006-06-24 20:30:19 +09001023/*
1024 * port helpers
1025 */
1026static inline int ata_port_max_devices(const struct ata_port *ap)
1027{
1028 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1029 return 2;
1030 return 1;
1031}
1032
1033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034static inline u8 ata_chk_status(struct ata_port *ap)
1035{
1036 return ap->ops->check_status(ap);
1037}
1038
Tejun Heo6d1245b2007-02-20 23:20:27 +09001039/**
1040 * ata_ncq_enabled - Test whether NCQ is enabled
1041 * @dev: ATA device to test for
1042 *
1043 * LOCKING:
1044 * spin_lock_irqsave(host lock)
1045 *
1046 * RETURNS:
1047 * 1 if NCQ is enabled for @dev, 0 otherwise.
1048 */
1049static inline int ata_ncq_enabled(struct ata_device *dev)
1050{
1051 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1052 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1053}
Edward Falk0baab862005-06-02 18:17:13 -04001054
1055/**
1056 * ata_pause - Flush writes and pause 400 nanoseconds.
1057 * @ap: Port to wait for.
1058 *
1059 * LOCKING:
1060 * Inherited from caller.
1061 */
1062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063static inline void ata_pause(struct ata_port *ap)
1064{
1065 ata_altstatus(ap);
1066 ndelay(400);
1067}
1068
Edward Falk0baab862005-06-02 18:17:13 -04001069
1070/**
1071 * ata_busy_wait - Wait for a port status register
1072 * @ap: Port to wait for.
Alan07777212007-01-31 17:47:24 +00001073 * @bits: bits that must be clear
1074 * @max: number of 10uS waits to perform
Edward Falk0baab862005-06-02 18:17:13 -04001075 *
1076 * Waits up to max*10 microseconds for the selected bits in the port's
1077 * status register to be cleared.
1078 * Returns final value of status register.
1079 *
1080 * LOCKING:
1081 * Inherited from caller.
1082 */
1083
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1085 unsigned int max)
1086{
1087 u8 status;
1088
1089 do {
1090 udelay(10);
1091 status = ata_chk_status(ap);
1092 max--;
Tejun Heod1adc1b2006-10-09 18:32:15 +09001093 } while (status != 0xff && (status & bits) && (max > 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
1095 return status;
1096}
1097
Edward Falk0baab862005-06-02 18:17:13 -04001098
1099/**
1100 * ata_wait_idle - Wait for a port to be idle.
1101 * @ap: Port to wait for.
1102 *
1103 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1104 * Returns final value of status register.
1105 *
1106 * LOCKING:
1107 * Inherited from caller.
1108 */
1109
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110static inline u8 ata_wait_idle(struct ata_port *ap)
1111{
1112 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1113
Tejun Heod1adc1b2006-10-09 18:32:15 +09001114 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
Randy Dunlapbfd60572006-01-17 19:34:42 -05001115 if (ata_msg_warn(ap))
Tejun Heo0d5ff562007-02-01 15:06:36 +09001116 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%p\n",
1117 status, ap->ioaddr.status_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 }
1119
1120 return status;
1121}
1122
1123static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1124{
1125 qc->tf.ctl |= ATA_NIEN;
1126}
1127
Tejun Heof69499f2006-05-15 20:58:03 +09001128static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1129 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130{
1131 if (likely(ata_tag_valid(tag)))
1132 return &ap->qcmd[tag];
1133 return NULL;
1134}
1135
Tejun Heof69499f2006-05-15 20:58:03 +09001136static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1137 unsigned int tag)
1138{
1139 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1140
1141 if (unlikely(!qc) || !ap->ops->error_handler)
1142 return qc;
1143
1144 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1145 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1146 return qc;
1147
1148 return NULL;
1149}
1150
Tejun Heo3373efd2006-05-15 20:57:53 +09001151static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152{
1153 memset(tf, 0, sizeof(*tf));
1154
Tejun Heo3373efd2006-05-15 20:57:53 +09001155 tf->ctl = dev->ap->ctl;
1156 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 tf->device = ATA_DEVICE_OBS;
1158 else
1159 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1160}
1161
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001162static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1163{
Tejun Heo501e0c502007-01-17 11:34:02 +09001164 qc->dma_dir = DMA_NONE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001165 qc->__sg = NULL;
1166 qc->flags = 0;
Tejun Heo726f0782007-01-03 17:30:39 +09001167 qc->cursg = qc->cursg_ofs = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001168 qc->nbytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001169 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001170 qc->err_mask = 0;
Brian Kingd0f29482007-01-17 12:32:28 -06001171 qc->pad_len = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001172 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001173
Tejun Heo3373efd2006-05-15 20:57:53 +09001174 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001175
1176 /* init result_tf such that it indicates normal completion */
1177 qc->result_tf.command = ATA_DRDY;
1178 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001179}
1180
Jeff Garzik057ace52005-10-22 14:27:05 -04001181static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182{
1183 return ata_id_wcache_enabled(dev->id) ||
1184 ata_id_has_flush(dev->id) ||
1185 ata_id_has_flush_ext(dev->id);
1186}
1187
Jeff Garzika7dac442005-10-30 04:44:42 -05001188static inline unsigned int ac_err_mask(u8 status)
1189{
Albert Lee3655d1d2006-05-19 11:43:04 +08001190 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001191 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001192 if (status & (ATA_ERR | ATA_DF))
1193 return AC_ERR_DEV;
1194 return 0;
1195}
1196
1197static inline unsigned int __ac_err_mask(u8 status)
1198{
1199 unsigned int mask = ac_err_mask(status);
1200 if (mask == 0)
1201 return AC_ERR_OTHER;
1202 return mask;
1203}
1204
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001205static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1206{
1207 ap->pad_dma = 0;
Tejun Heof0d36ef2007-01-20 16:00:28 +09001208 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1209 &ap->pad_dma, GFP_KERNEL);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001210 return (ap->pad == NULL) ? -ENOMEM : 0;
1211}
1212
1213static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1214{
Tejun Heof0d36ef2007-01-20 16:00:28 +09001215 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001216}
1217
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001218static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1219{
Tejun Heo49114872007-04-17 23:44:06 +09001220 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001221}
1222
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223#endif /* __LINUX_LIBATA_H__ */