blob: a41749820964d0c873875ee684582a0efa20ccd2 [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 */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000215 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
216 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900217 ATA_TMOUT_INTERNAL = 30 * HZ,
218 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220 /* ATA bus states */
221 BUS_UNKNOWN = 0,
222 BUS_DMA = 1,
223 BUS_IDLE = 2,
224 BUS_NOINTR = 3,
225 BUS_NODATA = 4,
226 BUS_TIMER = 5,
227 BUS_PIO = 6,
228 BUS_EDD = 7,
229 BUS_IDENTIFY = 8,
230 BUS_PACKET = 9,
231
232 /* SATA port states */
233 PORT_UNKNOWN = 0,
234 PORT_ENABLED = 1,
235 PORT_DISABLED = 2,
236
237 /* encoding various smaller bitmaps into a single
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900238 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 */
Alan Coxb352e572006-08-10 18:52:12 +0100240 ATA_BITS_PIO = 7,
241 ATA_BITS_MWDMA = 5,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900242 ATA_BITS_UDMA = 8,
243
244 ATA_SHIFT_PIO = 0,
245 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
246 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
247
248 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
249 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
250 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400251
252 /* size of buffer to pad xfers ending on unaligned boundaries */
253 ATA_DMA_PAD_SZ = 4,
254 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Tejun Heo949b38a2006-04-02 18:51:52 +0900255
256 /* masks for port functions */
Alan Cox47a86592005-10-04 08:09:19 -0400257 ATA_PORT_PRIMARY = (1 << 0),
258 ATA_PORT_SECONDARY = (1 << 1),
Tejun Heo14d2bac2006-04-02 17:54:46 +0900259
Tejun Heo0c247c52006-05-15 20:58:19 +0900260 /* ering size */
261 ATA_ERING_SIZE = 32,
262
Tejun Heof3e81b12006-05-15 20:58:21 +0900263 /* desc_len for ata_eh_info and context */
264 ATA_EH_DESC_LEN = 80,
265
Tejun Heo9be1e972006-05-15 20:58:17 +0900266 /* reset / recovery action types */
267 ATA_EH_REVALIDATE = (1 << 0),
268 ATA_EH_SOFTRESET = (1 << 1),
269 ATA_EH_HARDRESET = (1 << 2),
Tejun Heo02670bf2006-07-03 16:07:26 +0900270 ATA_EH_SUSPEND = (1 << 3),
271 ATA_EH_RESUME = (1 << 4),
272 ATA_EH_PM_FREEZE = (1 << 5),
Tejun Heo9be1e972006-05-15 20:58:17 +0900273
274 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heo02670bf2006-07-03 16:07:26 +0900275 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
276 ATA_EH_RESUME | ATA_EH_PM_FREEZE,
Tejun Heo9be1e972006-05-15 20:58:17 +0900277
Tejun Heof3e81b12006-05-15 20:58:21 +0900278 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900279 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo13abf502006-07-10 23:18:46 +0900280 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900281 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
282 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900283
284 ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */
Tejun Heoefdaedc2006-11-01 18:38:52 +0900285 ATA_EHI_PRINTINFO = (1 << 17), /* print configuration info */
Tejun Heobaa1e782006-11-01 18:39:27 +0900286 ATA_EHI_SETMODE = (1 << 18), /* configure transfer mode */
287 ATA_EHI_POST_SETMODE = (1 << 19), /* revaildating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900288
Tejun Heo13abf502006-07-10 23:18:46 +0900289 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
290
Tejun Heoad9e2762006-05-15 20:58:12 +0900291 /* max repeat if error condition is still set after ->error_handler */
292 ATA_EH_MAX_REPEAT = 5,
293
Tejun Heo14d2bac2006-04-02 17:54:46 +0900294 /* how hard are we gonna try to probe/recover devices */
295 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900296 ATA_EH_RESET_TRIES = 3,
297 ATA_EH_DEV_TRIES = 3,
Tejun Heof5914a42006-05-31 18:27:48 +0900298
299 /* Drive spinup time (time from power-on to the first D2H FIS)
300 * in msecs - 8s currently. Failing to get ready in this time
301 * isn't critical. It will result in reset failure for
302 * controllers which can't wait for the first D2H FIS. libata
303 * will retry, so it just has to be long enough to spin up
304 * most devices.
305 */
306 ATA_SPINUP_WAIT = 8000,
Jeff Garzikf20b16f2006-12-11 11:14:06 -0500307
Alan Cox93590852006-09-12 16:55:12 +0100308 /* Horkage types. May be set by libata or controller on drives
309 (some horkage may be drive/controller pair dependant */
310
311 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700312 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
313 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800314 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Albert Lee6f23a312007-04-02 11:39:25 +0800315 ATA_HORKAGE_DMA_RW_ONLY = (1 << 4), /* ATAPI DMA for RW only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316};
317
Albert Lee14be71f2005-09-27 17:36:35 +0800318enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800319 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800320 HSM_ST_FIRST, /* (waiting the device to)
321 write CDB or first data block */
Albert Leec56b14d22005-09-30 19:07:39 +0800322 HSM_ST, /* (waiting the device to) transfer data */
323 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800324 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325};
326
Jeff Garzika7dac442005-10-30 04:44:42 -0500327enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900328 AC_ERR_DEV = (1 << 0), /* device reported error */
329 AC_ERR_HSM = (1 << 1), /* host state machine violation */
330 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
331 AC_ERR_MEDIA = (1 << 3), /* media error */
332 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
333 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
334 AC_ERR_SYSTEM = (1 << 6), /* system error */
335 AC_ERR_INVALID = (1 << 7), /* invalid argument */
336 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900337 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Jeff Garzika7dac442005-10-30 04:44:42 -0500338};
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340/* forward declarations */
341struct scsi_device;
342struct ata_port_operations;
343struct ata_port;
344struct ata_queued_cmd;
345
346/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900347typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heof5914a42006-05-31 18:27:48 +0900348typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
349typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
350typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900353 void __iomem *cmd_addr;
354 void __iomem *data_addr;
355 void __iomem *error_addr;
356 void __iomem *feature_addr;
357 void __iomem *nsect_addr;
358 void __iomem *lbal_addr;
359 void __iomem *lbam_addr;
360 void __iomem *lbah_addr;
361 void __iomem *device_addr;
362 void __iomem *status_addr;
363 void __iomem *command_addr;
364 void __iomem *altstatus_addr;
365 void __iomem *ctl_addr;
366 void __iomem *bmdma_addr;
367 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368};
369
370struct ata_probe_ent {
371 struct list_head node;
372 struct device *dev;
Jeff Garzik057ace52005-10-22 14:27:05 -0400373 const struct ata_port_operations *port_ops;
Jeff Garzik193515d2005-11-07 00:59:37 -0500374 struct scsi_host_template *sht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 struct ata_ioports port[ATA_MAX_PORTS];
376 unsigned int n_ports;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900377 unsigned int dummy_port_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 unsigned int pio_mask;
379 unsigned int mwdma_mask;
380 unsigned int udma_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900382 unsigned long irq2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 unsigned int irq_flags;
Jeff Garzikcca39742006-08-24 03:19:22 -0400384 unsigned long port_flags;
385 unsigned long _host_flags;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900386 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 void *private_data;
Tejun Heofea63e32006-09-16 03:04:15 +0900388
389 /* port_info for the secondary port. Together with irq2, it's
390 * used to implement non-uniform secondary port. Currently,
391 * the only user is ata_piix combined mode. This workaround
392 * will be removed together with ata_probe_ent when init model
393 * is updated.
394 */
395 const struct ata_port_info *pinfo2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396};
397
Jeff Garzikcca39742006-08-24 03:19:22 -0400398struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 spinlock_t lock;
400 struct device *dev;
401 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900402 unsigned long irq2;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900403 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 unsigned int n_ports;
405 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400406 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100407 unsigned long flags;
Alan032af1c2007-03-01 17:36:46 +0000408 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900409 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410};
411
412struct ata_queued_cmd {
413 struct ata_port *ap;
414 struct ata_device *dev;
415
416 struct scsi_cmnd *scsicmd;
417 void (*scsidone)(struct scsi_cmnd *);
418
419 struct ata_taskfile tf;
420 u8 cdb[ATAPI_CDB_LEN];
421
422 unsigned long flags; /* ATA_QCFLAG_xxx */
423 unsigned int tag;
424 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400425 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
427 int dma_dir;
428
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400429 unsigned int pad_len;
430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 unsigned int nbytes;
432 unsigned int curbytes;
433
434 unsigned int cursg;
435 unsigned int cursg_ofs;
436
437 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400438 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 void *buf_virt;
440
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400441 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
442 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Albert Leea22e2eb2005-12-05 15:38:02 +0800444 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900445 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 ata_qc_cb_t complete_fn;
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 void *private_data;
449};
450
Jeff Garzikcca39742006-08-24 03:19:22 -0400451struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 unsigned long unhandled_irq;
453 unsigned long idle_irq;
454 unsigned long rw_reqbuf;
455};
456
Tejun Heo0c247c52006-05-15 20:58:19 +0900457struct ata_ering_entry {
458 int is_io;
459 unsigned int err_mask;
460 u64 timestamp;
461};
462
463struct ata_ering {
464 int cursor;
465 struct ata_ering_entry ring[ATA_ERING_SIZE];
466};
467
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468struct ata_device {
Tejun Heo38d87232006-05-15 20:57:51 +0900469 struct ata_port *ap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 unsigned int devno; /* 0 or 1 */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900471 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900472 struct scsi_device *sdev; /* attached SCSI device */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900473 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
474 u64 n_sectors; /* size of device, if ATA */
475 unsigned int class; /* ATA_DEV_xxx */
Tejun Heofe635c72006-05-15 20:57:35 +0900476 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 u8 pio_mode;
478 u8 dma_mode;
479 u8 xfer_mode;
480 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
481
Albert Lee8cbd6df2005-10-12 15:06:27 +0800482 unsigned int multi_count; /* sectors count for
483 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900484 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900485 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400486
Tejun Heoacf356b2006-03-24 14:07:50 +0900487 /* per-dev xfer mask */
488 unsigned int pio_mask;
489 unsigned int mwdma_mask;
490 unsigned int udma_mask;
491
Albert Lee8bf62ece2005-05-12 15:29:42 -0400492 /* for CHS addressing */
493 u16 cylinders; /* Number of cylinders */
494 u16 heads; /* Number of heads */
495 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900496
497 /* error history */
498 struct ata_ering ering;
Tejun Heo7d47e8d2007-02-02 16:22:31 +0900499 int spdn_cnt;
Alan Cox93590852006-09-12 16:55:12 +0100500 unsigned int horkage; /* List of broken features */
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700501#ifdef CONFIG_SATA_ACPI
502 /* ACPI objects info */
503 acpi_handle obj_handle;
504#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505};
506
Tejun Heo72fa4b72006-05-31 18:27:32 +0900507/* Offset into struct ata_device. Fields above it are maintained
508 * acress device init. Fields below are zeroed.
509 */
510#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
511
Tejun Heof3e81b12006-05-15 20:58:21 +0900512struct ata_eh_info {
513 struct ata_device *dev; /* offending device */
514 u32 serror; /* SError from LLDD */
515 unsigned int err_mask; /* port-wide err_mask */
516 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900517 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900518 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900519
520 unsigned long hotplug_timestamp;
521 unsigned int probe_mask;
522
Tejun Heof3e81b12006-05-15 20:58:21 +0900523 char desc[ATA_EH_DESC_LEN];
524 int desc_len;
525};
526
527struct ata_eh_context {
528 struct ata_eh_info i;
529 int tries[ATA_MAX_DEVICES];
Tejun Heoabdda732006-05-31 18:27:29 +0900530 unsigned int classes[ATA_MAX_DEVICES];
531 unsigned int did_probe_mask;
Tejun Heof3e81b12006-05-15 20:58:21 +0900532};
533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400535 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400536 const struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400537 spinlock_t *lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 unsigned long flags; /* ATA_FLAG_xxx */
Tejun Heob51e9e52006-06-29 01:29:30 +0900539 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900540 unsigned int print_id; /* user visible unique port ID */
541 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
543 struct ata_prd *prd; /* our SG list */
544 dma_addr_t prd_dma; /* and its DMA mapping */
545
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400546 void *pad; /* array of DMA pad buffers */
547 dma_addr_t pad_dma;
548
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
550
551 u8 ctl; /* cache of ATA control register */
552 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 unsigned int pio_mask;
554 unsigned int mwdma_mask;
555 unsigned int udma_mask;
556 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Tejun Heo5a04bf42006-05-31 18:27:38 +0900557 unsigned int hw_sata_spd_limit;
Tejun Heo1c3fae42006-04-02 20:53:28 +0900558 unsigned int sata_spd_limit; /* SATA PHY speed limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Jeff Garzikcca39742006-08-24 03:19:22 -0400560 /* record runtime error info, protected by host lock */
Tejun Heof3e81b12006-05-15 20:58:21 +0900561 struct ata_eh_info eh_info;
562 /* EH context owned by EH */
563 struct ata_eh_context eh_context;
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 struct ata_device device[ATA_MAX_DEVICES];
566
567 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900568 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900569 unsigned int qc_active;
570
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 unsigned int active_tag;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900572 u32 sactive;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Jeff Garzikcca39742006-08-24 03:19:22 -0400574 struct ata_port_stats stats;
575 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600576 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
David Howells65f27f32006-11-22 14:55:48 +0000578 void *port_task_data;
David Howells52bad642006-11-22 14:54:01 +0000579 struct delayed_work port_task;
580 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400581 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900582
Albert Lee14be71f2005-09-27 17:36:35 +0800583 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Randy Dunlapbfd60572006-01-17 19:34:42 -0500585 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900586 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900587 wait_queue_head_t eh_wait_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500588
Tejun Heo500530f2006-07-03 16:07:27 +0900589 pm_message_t pm_mesg;
590 int *pm_result;
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900593
594 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595};
596
597struct ata_port_operations {
598 void (*port_disable) (struct ata_port *);
599
600 void (*dev_config) (struct ata_port *, struct ata_device *);
601
602 void (*set_piomode) (struct ata_port *, struct ata_device *);
603 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Cox5444a6f2006-03-27 18:58:20 +0100604 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
Jeff Garzik057ace52005-10-22 14:27:05 -0400606 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
608
Jeff Garzik057ace52005-10-22 14:27:05 -0400609 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 u8 (*check_status)(struct ata_port *ap);
611 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 void (*dev_select)(struct ata_port *ap, unsigned int device);
613
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900614 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Alanb229a7b2007-01-24 11:47:07 +0000615 int (*set_mode) (struct ata_port *ap, struct ata_device **r_failed_dev);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900616
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 void (*post_set_mode) (struct ata_port *ap);
618
Alanb229a7b2007-01-24 11:47:07 +0000619 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
621 void (*bmdma_setup) (struct ata_queued_cmd *qc);
622 void (*bmdma_start) (struct ata_queued_cmd *qc);
623
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100624 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900627 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Tejun Heo9ec957f2006-05-15 20:57:58 +0900629 /* Error handlers. ->error_handler overrides ->eng_timeout and
630 * indicates that new-style EH is in place.
631 */
632 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
633
634 void (*freeze) (struct ata_port *ap);
635 void (*thaw) (struct ata_port *ap);
636 void (*error_handler) (struct ata_port *ap);
637 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
David Howells7d12e782006-10-05 14:55:46 +0100639 irq_handler_t irq_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 void (*irq_clear) (struct ata_port *);
Akira Iguchi83625002007-01-26 16:27:32 +0900641 u8 (*irq_on) (struct ata_port *);
642 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
644 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
645 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
646 u32 val);
647
Tejun Heo500530f2006-07-03 16:07:27 +0900648 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
649 int (*port_resume) (struct ata_port *ap);
650
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 int (*port_start) (struct ata_port *ap);
652 void (*port_stop) (struct ata_port *ap);
653
Jeff Garzikcca39742006-08-24 03:19:22 -0400654 void (*host_stop) (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Alan Coxb73fc892005-08-26 16:03:19 +0100656 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 u8 (*bmdma_status) (struct ata_port *ap);
658};
659
660struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100661 struct scsi_host_template *sht;
Jeff Garzikcca39742006-08-24 03:19:22 -0400662 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 unsigned long pio_mask;
664 unsigned long mwdma_mask;
665 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400666 const struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000667 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668};
669
Alan Cox452503f2005-10-21 19:01:32 -0400670struct ata_timing {
671 unsigned short mode; /* ATA mode */
672 unsigned short setup; /* t1 */
673 unsigned short act8b; /* t2 for 8-bit I/O */
674 unsigned short rec8b; /* t2i for 8-bit I/O */
675 unsigned short cyc8b; /* t0 for 8-bit I/O */
676 unsigned short active; /* t2 or tD */
677 unsigned short recover; /* t2i or tK */
678 unsigned short cycle; /* t0 */
679 unsigned short udma; /* t2CYCTYP/2 */
680};
681
682#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Tejun Heoe9c83912006-07-03 16:07:26 +0900684extern const unsigned long sata_deb_timing_normal[];
685extern const unsigned long sata_deb_timing_hotplug[];
686extern const unsigned long sata_deb_timing_long[];
687
Tejun Heodd5b06c2006-08-10 16:59:12 +0900688extern const struct ata_port_operations ata_dummy_port_ops;
689
Tejun Heoe9c83912006-07-03 16:07:26 +0900690static inline const unsigned long *
691sata_ehc_deb_timing(struct ata_eh_context *ehc)
692{
693 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
694 return sata_deb_timing_hotplug;
695 else
696 return sata_deb_timing_normal;
697}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900698
Tejun Heodd5b06c2006-08-10 16:59:12 +0900699static inline int ata_port_is_dummy(struct ata_port *ap)
700{
701 return ap->ops == &ata_dummy_port_ops;
702}
703
Jeff Garzik43727fb2007-02-25 16:50:52 -0500704extern void sata_print_link_status(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705extern void ata_port_probe(struct ata_port *);
706extern void __sata_phy_reset(struct ata_port *ap);
707extern void sata_phy_reset(struct ata_port *ap);
708extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo3c567b72006-05-15 20:57:23 +0900709extern int sata_set_spd(struct ata_port *ap);
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900710extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
711extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
Tejun Heof5914a42006-05-31 18:27:48 +0900712extern int ata_std_prereset(struct ata_port *ap);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900713extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
Tejun Heob6103f62006-11-01 17:59:53 +0900714extern int sata_port_hardreset(struct ata_port *ap,
715 const unsigned long *timing);
Tejun Heo2bf2cb22006-04-11 22:16:45 +0900716extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
Tejun Heoc2bd5802006-01-24 17:05:22 +0900717extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718extern void ata_port_disable(struct ata_port *);
719extern void ata_std_ports(struct ata_ioports *ioaddr);
720#ifdef CONFIG_PCI
721extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
722 unsigned int n_ports);
723extern void ata_pci_remove_one (struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900724#ifdef CONFIG_PM
Tejun Heo3c5100c2006-07-26 16:58:33 +0900725extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
Tejun Heo553c4aa2006-12-26 19:39:50 +0900726extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900727extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
Jens Axboe9b847542006-01-06 09:28:07 +0100728extern int ata_pci_device_resume(struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900729#endif
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500730extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731#endif /* CONFIG_PCI */
Jeff Garzik057ace52005-10-22 14:27:05 -0400732extern int ata_device_add(const struct ata_probe_ent *ent);
Tejun Heo0529c152007-01-20 16:00:26 +0900733extern void ata_host_detach(struct ata_host *host);
Jeff Garzikcca39742006-08-24 03:19:22 -0400734extern void ata_host_init(struct ata_host *, struct device *,
735 unsigned long, const struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -0500736extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
738extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Brian King80289162006-08-07 14:27:31 -0500739extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400740extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500741 struct ata_port_info *, struct Scsi_Host *);
742extern int ata_sas_port_init(struct ata_port *);
743extern int ata_sas_port_start(struct ata_port *ap);
744extern void ata_sas_port_stop(struct ata_port *ap);
745extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
746extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
747 struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo34bf2172006-05-15 20:57:46 +0900749extern int sata_scr_valid(struct ata_port *ap);
750extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
751extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
752extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
753extern int ata_port_online(struct ata_port *ap);
754extern int ata_port_offline(struct ata_port *ap);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900755#ifdef CONFIG_PM
Jens Axboe9b847542006-01-06 09:28:07 +0100756extern int ata_scsi_device_resume(struct scsi_device *);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900757extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
Jeff Garzikcca39742006-08-24 03:19:22 -0400758extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
759extern void ata_host_resume(struct ata_host *host);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900760#endif
Jeff Garzik67846b32005-10-05 02:58:32 -0400761extern int ata_ratelimit(void);
Tejun Heod1adc1b2006-10-09 18:32:15 +0900762extern int ata_busy_sleep(struct ata_port *ap,
763 unsigned long timeout_pat, unsigned long timeout);
David Howells65f27f32006-11-22 14:55:48 +0000764extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
Tejun Heo86e45b62006-03-05 15:29:09 +0900765 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900766extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
767 unsigned long interval_msec,
768 unsigned long timeout_msec);
Akira Iguchia619f981b2007-01-26 16:28:18 +0900769extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
Jeff Garzik67846b32005-10-05 02:58:32 -0400770
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771/*
772 * Default driver ops implementations
773 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400774extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Jeff Garzik057ace52005-10-22 14:27:05 -0400776extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
777extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
779extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
780extern u8 ata_check_status(struct ata_port *ap);
781extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400782extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783extern int ata_port_start (struct ata_port *ap);
David Howells7d12e782006-10-05 14:55:46 +0100784extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900785extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
786 unsigned int buflen, int write_data);
787extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
788 unsigned int buflen, int write_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600790extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900791extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
793 unsigned int buflen);
794extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
795 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400796extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +0000797extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +0900798extern void ata_id_string(const u16 *id, unsigned char *s,
799 unsigned int ofs, unsigned int len);
800extern void ata_id_c_string(const u16 *id, unsigned char *s,
801 unsigned int ofs, unsigned int len);
Alan10305f02007-02-20 18:01:59 +0000802extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
Alan Cox6919a0a2006-10-27 19:08:46 -0700803extern unsigned long ata_device_blacklisted(const struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
805extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100806extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807extern u8 ata_bmdma_status(struct ata_port *ap);
808extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900809extern void ata_bmdma_freeze(struct ata_port *ap);
810extern void ata_bmdma_thaw(struct ata_port *ap);
Tejun Heof5914a42006-05-31 18:27:48 +0900811extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900812 ata_reset_fn_t softreset,
813 ata_reset_fn_t hardreset,
814 ata_postreset_fn_t postreset);
815extern void ata_bmdma_error_handler(struct ata_port *ap);
816extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo9a1004d2006-05-31 18:27:52 +0900817extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
818 u8 status, int in_wq);
Tejun Heof686bcb2006-05-15 20:58:05 +0900819extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900820extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
821 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900822extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 void (*done)(struct scsi_cmnd *));
824extern int ata_std_bios_param(struct scsi_device *sdev,
825 struct block_device *bdev,
826 sector_t capacity, int geom[]);
827extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900828extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900829extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
830 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900831extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Akira Iguchi83625002007-01-26 16:27:32 +0900832extern u8 ata_irq_on(struct ata_port *ap);
833extern u8 ata_dummy_irq_on(struct ata_port *ap);
834extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
835extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Alan Cox452503f2005-10-21 19:01:32 -0400837/*
838 * Timing helpers
839 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000840
841extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400842extern int ata_timing_compute(struct ata_device *, unsigned short,
843 struct ata_timing *, int, int);
844extern void ata_timing_merge(const struct ata_timing *,
845 const struct ata_timing *, struct ata_timing *,
846 unsigned int);
847
848enum {
849 ATA_TIMING_SETUP = (1 << 0),
850 ATA_TIMING_ACT8B = (1 << 1),
851 ATA_TIMING_REC8B = (1 << 2),
852 ATA_TIMING_CYC8B = (1 << 3),
853 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
854 ATA_TIMING_CYC8B,
855 ATA_TIMING_ACTIVE = (1 << 4),
856 ATA_TIMING_RECOVER = (1 << 5),
857 ATA_TIMING_CYCLE = (1 << 6),
858 ATA_TIMING_UDMA = (1 << 7),
859 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
860 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
861 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
862 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
863};
864
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
866#ifdef CONFIG_PCI
867struct pci_bits {
868 unsigned int reg; /* PCI config register to read */
869 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
870 unsigned long mask;
871 unsigned long val;
872};
873
874extern struct ata_probe_ent *
Alan Cox47a86592005-10-04 08:09:19 -0400875ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
Jeff Garzik057ace52005-10-22 14:27:05 -0400876extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500877extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878#endif /* CONFIG_PCI */
879
Tejun Heoece1d632006-04-02 18:51:53 +0900880/*
881 * EH
882 */
Tejun Heoece1d632006-04-02 18:51:53 +0900883extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900884
885extern void ata_port_schedule_eh(struct ata_port *ap);
886extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900887extern int ata_port_freeze(struct ata_port *ap);
888
889extern void ata_eh_freeze_port(struct ata_port *ap);
890extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900891
Tejun Heoece1d632006-04-02 18:51:53 +0900892extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
893extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
894
Tejun Heof5914a42006-05-31 18:27:48 +0900895extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
896 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
897 ata_postreset_fn_t postreset);
Tejun Heo022bdb02006-05-15 20:58:22 +0900898
Tejun Heo61440db2006-05-15 20:57:55 +0900899/*
900 * printk helpers
901 */
902#define ata_port_printk(ap, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900903 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Tejun Heo61440db2006-05-15 20:57:55 +0900905#define ata_dev_printk(dev, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900906 printk(lv"ata%u.%02u: "fmt, (dev)->ap->print_id, (dev)->devno , ##args)
Tejun Heo61440db2006-05-15 20:57:55 +0900907
908/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900909 * ata_eh_info helpers
910 */
911#define ata_ehi_push_desc(ehi, fmt, args...) do { \
912 (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
913 ATA_EH_DESC_LEN - (ehi)->desc_len, \
914 fmt , ##args); \
915} while (0)
916
917#define ata_ehi_clear_desc(ehi) do { \
918 (ehi)->desc[0] = '\0'; \
919 (ehi)->desc_len = 0; \
920} while (0)
921
Tejun Heoc0b6c032006-07-03 16:07:26 +0900922static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
Tejun Heo084fe632006-05-31 18:28:03 +0900923{
924 if (ehi->flags & ATA_EHI_HOTPLUGGED)
925 return;
926
Tejun Heo28324302006-07-03 16:07:26 +0900927 ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
Tejun Heo084fe632006-05-31 18:28:03 +0900928 ehi->hotplug_timestamp = jiffies;
929
Tejun Heo084fe632006-05-31 18:28:03 +0900930 ehi->action |= ATA_EH_SOFTRESET;
931 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
932}
933
Tejun Heoc0b6c032006-07-03 16:07:26 +0900934static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
935{
936 __ata_ehi_hotplugged(ehi);
937 ehi->err_mask |= AC_ERR_ATA_BUS;
938}
939
Tejun Heof3e81b12006-05-15 20:58:21 +0900940/*
Tejun Heo61440db2006-05-15 20:57:55 +0900941 * qc helpers
942 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400943static inline int
944ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
945{
946 if (sg == &qc->pad_sgent)
947 return 1;
948 if (qc->pad_len)
949 return 0;
950 if (((sg - qc->__sg) + 1) == qc->n_elem)
951 return 1;
952 return 0;
953}
954
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400955static inline struct scatterlist *
Tejun Heocc1887f32006-02-20 23:48:38 +0900956ata_qc_first_sg(struct ata_queued_cmd *qc)
957{
958 if (qc->n_elem)
959 return qc->__sg;
960 if (qc->pad_len)
961 return &qc->pad_sgent;
962 return NULL;
963}
964
965static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400966ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
967{
968 if (sg == &qc->pad_sgent)
969 return NULL;
970 if (++sg - qc->__sg < qc->n_elem)
971 return sg;
Tejun Heocc1887f32006-02-20 23:48:38 +0900972 if (qc->pad_len)
973 return &qc->pad_sgent;
974 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400975}
976
977#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f32006-02-20 23:48:38 +0900978 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400979
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980static inline unsigned int ata_tag_valid(unsigned int tag)
981{
982 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
983}
984
Tejun Heo2ab7db12006-05-15 20:58:02 +0900985static inline unsigned int ata_tag_internal(unsigned int tag)
986{
987 return tag == ATA_MAX_QUEUE - 1;
988}
989
Tejun Heo5806db22006-06-24 20:30:19 +0900990/*
991 * device helpers
992 */
Tejun Heoe1211e32006-04-01 01:38:18 +0900993static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +0900994{
995 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
996}
997
Tejun Heoe1211e32006-04-01 01:38:18 +0900998static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999{
Tejun Heoe1211e32006-04-01 01:38:18 +09001000 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
1001}
1002
Tejun Heo002c8052006-04-02 17:54:46 +09001003static inline unsigned int ata_class_absent(unsigned int class)
1004{
1005 return !ata_class_enabled(class) && !ata_class_disabled(class);
1006}
1007
Tejun Heoe1211e32006-04-01 01:38:18 +09001008static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1009{
1010 return ata_class_enabled(dev->class);
1011}
1012
1013static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1014{
1015 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016}
1017
Tejun Heo002c8052006-04-02 17:54:46 +09001018static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1019{
1020 return ata_class_absent(dev->class);
1021}
1022
Tejun Heo02670bf2006-07-03 16:07:26 +09001023static inline unsigned int ata_dev_ready(const struct ata_device *dev)
1024{
1025 return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
1026}
1027
Tejun Heo5806db22006-06-24 20:30:19 +09001028/*
1029 * port helpers
1030 */
1031static inline int ata_port_max_devices(const struct ata_port *ap)
1032{
1033 if (ap->flags & ATA_FLAG_SLAVE_POSS)
1034 return 2;
1035 return 1;
1036}
1037
1038
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039static inline u8 ata_chk_status(struct ata_port *ap)
1040{
1041 return ap->ops->check_status(ap);
1042}
1043
Tejun Heo6d1245b2007-02-20 23:20:27 +09001044/**
1045 * ata_ncq_enabled - Test whether NCQ is enabled
1046 * @dev: ATA device to test for
1047 *
1048 * LOCKING:
1049 * spin_lock_irqsave(host lock)
1050 *
1051 * RETURNS:
1052 * 1 if NCQ is enabled for @dev, 0 otherwise.
1053 */
1054static inline int ata_ncq_enabled(struct ata_device *dev)
1055{
1056 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1057 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1058}
Edward Falk0baab862005-06-02 18:17:13 -04001059
1060/**
1061 * ata_pause - Flush writes and pause 400 nanoseconds.
1062 * @ap: Port to wait for.
1063 *
1064 * LOCKING:
1065 * Inherited from caller.
1066 */
1067
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068static inline void ata_pause(struct ata_port *ap)
1069{
1070 ata_altstatus(ap);
1071 ndelay(400);
1072}
1073
Edward Falk0baab862005-06-02 18:17:13 -04001074
1075/**
1076 * ata_busy_wait - Wait for a port status register
1077 * @ap: Port to wait for.
Alan07777212007-01-31 17:47:24 +00001078 * @bits: bits that must be clear
1079 * @max: number of 10uS waits to perform
Edward Falk0baab862005-06-02 18:17:13 -04001080 *
1081 * Waits up to max*10 microseconds for the selected bits in the port's
1082 * status register to be cleared.
1083 * Returns final value of status register.
1084 *
1085 * LOCKING:
1086 * Inherited from caller.
1087 */
1088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1090 unsigned int max)
1091{
1092 u8 status;
1093
1094 do {
1095 udelay(10);
1096 status = ata_chk_status(ap);
1097 max--;
Tejun Heod1adc1b2006-10-09 18:32:15 +09001098 } while (status != 0xff && (status & bits) && (max > 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
1100 return status;
1101}
1102
Edward Falk0baab862005-06-02 18:17:13 -04001103
1104/**
1105 * ata_wait_idle - Wait for a port to be idle.
1106 * @ap: Port to wait for.
1107 *
1108 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1109 * Returns final value of status register.
1110 *
1111 * LOCKING:
1112 * Inherited from caller.
1113 */
1114
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115static inline u8 ata_wait_idle(struct ata_port *ap)
1116{
1117 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1118
Tejun Heod1adc1b2006-10-09 18:32:15 +09001119 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ))) {
Randy Dunlapbfd60572006-01-17 19:34:42 -05001120 if (ata_msg_warn(ap))
Tejun Heo0d5ff562007-02-01 15:06:36 +09001121 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%p\n",
1122 status, ap->ioaddr.status_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 }
1124
1125 return status;
1126}
1127
1128static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1129{
1130 qc->tf.ctl |= ATA_NIEN;
1131}
1132
Tejun Heof69499f2006-05-15 20:58:03 +09001133static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1134 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135{
1136 if (likely(ata_tag_valid(tag)))
1137 return &ap->qcmd[tag];
1138 return NULL;
1139}
1140
Tejun Heof69499f2006-05-15 20:58:03 +09001141static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1142 unsigned int tag)
1143{
1144 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1145
1146 if (unlikely(!qc) || !ap->ops->error_handler)
1147 return qc;
1148
1149 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1150 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1151 return qc;
1152
1153 return NULL;
1154}
1155
Tejun Heo3373efd2006-05-15 20:57:53 +09001156static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157{
1158 memset(tf, 0, sizeof(*tf));
1159
Tejun Heo3373efd2006-05-15 20:57:53 +09001160 tf->ctl = dev->ap->ctl;
1161 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 tf->device = ATA_DEVICE_OBS;
1163 else
1164 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1165}
1166
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001167static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1168{
Tejun Heo501e0c502007-01-17 11:34:02 +09001169 qc->dma_dir = DMA_NONE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001170 qc->__sg = NULL;
1171 qc->flags = 0;
Tejun Heo726f0782007-01-03 17:30:39 +09001172 qc->cursg = qc->cursg_ofs = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001173 qc->nbytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001174 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001175 qc->err_mask = 0;
Brian Kingd0f29482007-01-17 12:32:28 -06001176 qc->pad_len = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001177
Tejun Heo3373efd2006-05-15 20:57:53 +09001178 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001179
1180 /* init result_tf such that it indicates normal completion */
1181 qc->result_tf.command = ATA_DRDY;
1182 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001183}
1184
Jeff Garzik057ace52005-10-22 14:27:05 -04001185static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186{
1187 return ata_id_wcache_enabled(dev->id) ||
1188 ata_id_has_flush(dev->id) ||
1189 ata_id_has_flush_ext(dev->id);
1190}
1191
Jeff Garzika7dac442005-10-30 04:44:42 -05001192static inline unsigned int ac_err_mask(u8 status)
1193{
Albert Lee3655d1d2006-05-19 11:43:04 +08001194 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001195 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001196 if (status & (ATA_ERR | ATA_DF))
1197 return AC_ERR_DEV;
1198 return 0;
1199}
1200
1201static inline unsigned int __ac_err_mask(u8 status)
1202{
1203 unsigned int mask = ac_err_mask(status);
1204 if (mask == 0)
1205 return AC_ERR_OTHER;
1206 return mask;
1207}
1208
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001209static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1210{
1211 ap->pad_dma = 0;
Tejun Heof0d36ef2007-01-20 16:00:28 +09001212 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1213 &ap->pad_dma, GFP_KERNEL);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001214 return (ap->pad == NULL) ? -ENOMEM : 0;
1215}
1216
1217static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1218{
Tejun Heof0d36ef2007-01-20 16:00:28 +09001219 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001220}
1221
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001222static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1223{
1224 return (struct ata_port *) &host->hostdata[0];
1225}
1226
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227#endif /* __LINUX_LIBATA_H__ */