blob: 6fd24e03622ecd915a6a4160cfb400e1445c1d15 [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>
Andrew Morton1c72d8d2005-11-10 16:21:38 -080031#include <linux/dma-mapping.h>
Jens Axboe87260212007-10-16 11:14:12 +020032#include <linux/scatterlist.h>
Tejun Heof0d36ef2007-01-20 16:00:28 +090033#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/ata.h>
35#include <linux/workqueue.h>
Jeff Garzik35bb94b2006-04-11 13:12:34 -040036#include <scsi/scsi_host.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070037#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Jeff Garzika6d967a2006-09-25 15:33:09 -040039/*
40 * Define if arch has non-standard setup. This is a _PCI_ standard
41 * not a legacy or ISA standard.
42 */
43#ifdef CONFIG_ATA_NONSTANDARD
Alan Cox2ec7df02006-08-10 16:59:10 +090044#include <asm/libata-portmap.h>
Jeff Garzika6d967a2006-09-25 15:33:09 -040045#else
46#include <asm-generic/libata-portmap.h>
47#endif
Alan Cox2ec7df02006-08-10 16:59:10 +090048
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
Randy Dunlapbfd60572006-01-17 19:34:42 -050050 * compile-time options: to be removed as soon as all the drivers are
51 * converted to the new debugging mechanism
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 */
53#undef ATA_DEBUG /* debugging output */
54#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
55#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
56#undef ATA_NDEBUG /* define to disable quick runtime checks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58
59/* note: prints function name for you */
60#ifdef ATA_DEBUG
61#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
62#ifdef ATA_VERBOSE_DEBUG
63#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64#else
65#define VPRINTK(fmt, args...)
66#endif /* ATA_VERBOSE_DEBUG */
67#else
68#define DPRINTK(fmt, args...)
69#define VPRINTK(fmt, args...)
70#endif /* ATA_DEBUG */
71
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050072#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
73
Randy Dunlapbfd60572006-01-17 19:34:42 -050074/* NEW: debug levels */
75#define HAVE_LIBATA_MSG 1
76
77enum {
78 ATA_MSG_DRV = 0x0001,
79 ATA_MSG_INFO = 0x0002,
80 ATA_MSG_PROBE = 0x0004,
81 ATA_MSG_WARN = 0x0008,
82 ATA_MSG_MALLOC = 0x0010,
83 ATA_MSG_CTL = 0x0020,
84 ATA_MSG_INTR = 0x0040,
85 ATA_MSG_ERR = 0x0080,
86};
87
88#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
89#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
90#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
91#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
92#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
93#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
94#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
95#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
96
97static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
98{
99 if (dval < 0 || dval >= (sizeof(u32) * 8))
100 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
101 if (!dval)
102 return 0;
103 return (1 << dval) - 1;
104}
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106/* defines only for the constants which don't work well as enums */
107#define ATA_TAG_POISON 0xfafbfcfdU
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109enum {
110 /* various global constants */
111 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
Alan Coxd26fc952007-07-06 19:13:52 -0400112 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 ATA_MAX_PORTS = 8,
114 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900115 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900116 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900117 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 ATA_MAX_BUS = 2,
119 ATA_DEF_BUSY_WAIT = 10000,
120 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
121
122 ATA_SHT_EMULATED = 1,
123 ATA_SHT_CMD_PER_LUN = 1,
124 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400125 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
127 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900128 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
129 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400130 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900131 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900132 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heo67465442007-05-15 03:28:16 +0900133 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
134 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
Tejun Heo7d77b242007-09-23 13:14:13 +0900135 ATA_DFLAG_AN = (1 << 7), /* AN configured */
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700136 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900137
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700138 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
139 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
140 ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900141 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Tejun Heoabdda732006-05-31 18:27:29 +0900143 ATA_DFLAG_DETACH = (1 << 16),
144 ATA_DFLAG_DETACHED = (1 << 17),
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 ATA_DEV_UNKNOWN = 0, /* unknown device */
147 ATA_DEV_ATA = 1, /* ATA device */
148 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
149 ATA_DEV_ATAPI = 3, /* ATAPI device */
150 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
Tejun Heoe0a71752007-09-23 13:14:12 +0900151 ATA_DEV_PMP = 5, /* SATA port multiplier */
152 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
153 ATA_DEV_SEMB = 7, /* SEMB */
154 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
155 ATA_DEV_NONE = 9, /* no device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Tejun Heo0c887582007-08-06 18:36:23 +0900157 /* struct ata_link flags */
158 ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */
159 ATA_LFLAG_SKIP_D2H_BSY = (1 << 1), /* can't wait for the first D2H
160 * Register FIS clearing BSY */
Tejun Heoae791c02007-09-23 13:14:12 +0900161 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
162 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
163 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
164 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
Tejun Heofd995f72007-09-23 13:14:12 +0900165 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
Tejun Heof9df58c2007-09-23 13:14:13 +0900166 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
Tejun Heo0c887582007-08-06 18:36:23 +0900167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900169 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900171 ATA_FLAG_SATA = (1 << 1),
172 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
173 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
174 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
175 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
176 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
177 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
178 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900179 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
180 * doesn't handle PIO interrupts */
181 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Tejun Heo7395acb2006-05-31 18:27:25 +0900182 ATA_FLAG_DEBUGMSG = (1 << 13),
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900183 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800184 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Tejun Heo3cadbcc2007-05-15 03:28:15 +0900185 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -0400186 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
Tejun Heoe0a71752007-09-23 13:14:12 +0900187 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
Jens Axboe9b847542006-01-06 09:28:07 +0100188
Tejun Heob51e9e52006-06-29 01:29:30 +0900189 /* The following flag belongs to ap->pflags but is kept in
190 * ap->flags because it's referenced in many LLDs and will be
191 * removed in not-too-distant future.
192 */
193 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900194
Tejun Heob51e9e52006-06-29 01:29:30 +0900195 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000196
Tejun Heob51e9e52006-06-29 01:29:30 +0900197 /* struct ata_port pflags */
198 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
199 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
200 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
201 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
202 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
203 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
204 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
Tejun Heof4d6d002007-05-01 11:50:15 +0200205 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
Tejun Heoafaa5c32007-10-09 15:06:10 +0900206 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
Tejun Heob51e9e52006-06-29 01:29:30 +0900207
Tejun Heob51e9e52006-06-29 01:29:30 +0900208 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900209 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heo64578a32007-05-15 03:28:16 +0900210 ATA_PFLAG_GTM_VALID = (1 << 19), /* acpi_gtm data valid */
Tejun Heodde44582006-02-02 00:56:10 +0900211
Tejun Heo949b38a2006-04-02 18:51:52 +0900212 /* struct ata_queued_cmd flags */
213 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
214 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
215 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
Tejun Heo27197362006-04-02 18:51:53 +0900217 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900218 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
Tejun Heoda917d62007-09-23 13:14:12 +0900219 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
Tejun Heoe61e0672006-05-15 20:57:40 +0900220
Tejun Heo9ec957f2006-05-15 20:57:58 +0900221 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
222 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
223 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100225 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400226 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900227 ATA_HOST_STARTED = (1 << 1), /* Host started */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400228
Tejun Heob8b275e2007-07-10 15:55:43 +0900229 /* bits 24:31 of host->flags are reserved for LLD specific flags */
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000232 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
233 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900234 ATA_TMOUT_INTERNAL = 30 * HZ,
235 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237 /* ATA bus states */
238 BUS_UNKNOWN = 0,
239 BUS_DMA = 1,
240 BUS_IDLE = 2,
241 BUS_NOINTR = 3,
242 BUS_NODATA = 4,
243 BUS_TIMER = 5,
244 BUS_PIO = 6,
245 BUS_EDD = 7,
246 BUS_IDENTIFY = 8,
247 BUS_PACKET = 9,
248
249 /* SATA port states */
250 PORT_UNKNOWN = 0,
251 PORT_ENABLED = 1,
252 PORT_DISABLED = 2,
253
254 /* encoding various smaller bitmaps into a single
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900255 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 */
Alan Coxb352e572006-08-10 18:52:12 +0100257 ATA_BITS_PIO = 7,
258 ATA_BITS_MWDMA = 5,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900259 ATA_BITS_UDMA = 8,
260
261 ATA_SHIFT_PIO = 0,
262 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
263 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
264
265 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
266 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
267 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400268
269 /* size of buffer to pad xfers ending on unaligned boundaries */
270 ATA_DMA_PAD_SZ = 4,
271 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Tejun Heo949b38a2006-04-02 18:51:52 +0900272
Tejun Heo0c247c52006-05-15 20:58:19 +0900273 /* ering size */
274 ATA_ERING_SIZE = 32,
275
Tejun Heo31cc23b2007-09-23 13:14:12 +0900276 /* return values for ->qc_defer */
277 ATA_DEFER_LINK = 1,
278 ATA_DEFER_PORT = 2,
279
Tejun Heof3e81b12006-05-15 20:58:21 +0900280 /* desc_len for ata_eh_info and context */
281 ATA_EH_DESC_LEN = 80,
282
Tejun Heo9be1e972006-05-15 20:58:17 +0900283 /* reset / recovery action types */
284 ATA_EH_REVALIDATE = (1 << 0),
285 ATA_EH_SOFTRESET = (1 << 1),
286 ATA_EH_HARDRESET = (1 << 2),
Tejun Heof9df58c2007-09-23 13:14:13 +0900287 ATA_EH_ENABLE_LINK = (1 << 3),
Tejun Heo9be1e972006-05-15 20:58:17 +0900288
289 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heo9666f402007-05-04 21:27:47 +0200290 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
Tejun Heo9be1e972006-05-15 20:58:17 +0900291
Tejun Heof3e81b12006-05-15 20:58:21 +0900292 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900293 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo13abf502006-07-10 23:18:46 +0900294 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900295 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
296 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900297
Tejun Heo0d64a232007-04-23 02:41:05 +0900298 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
299 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
300 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
301 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
302 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900303
Tejun Heo0d64a232007-04-23 02:41:05 +0900304 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900305 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
306
Tejun Heoa1e10f72007-08-18 13:28:49 +0900307 /* max tries if error condition is still set after ->error_handler */
308 ATA_EH_MAX_TRIES = 5,
Tejun Heoad9e2762006-05-15 20:58:12 +0900309
Tejun Heo14d2bac2006-04-02 17:54:46 +0900310 /* how hard are we gonna try to probe/recover devices */
311 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900312 ATA_EH_DEV_TRIES = 3,
Tejun Heoe0a71752007-09-23 13:14:12 +0900313 ATA_EH_PMP_TRIES = 5,
314 ATA_EH_PMP_LINK_TRIES = 3,
315
316 SATA_PMP_SCR_TIMEOUT = 250,
Tejun Heof5914a42006-05-31 18:27:48 +0900317
Alan Cox93590852006-09-12 16:55:12 +0100318 /* Horkage types. May be set by libata or controller on drives
319 (some horkage may be drive/controller pair dependant */
320
321 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700322 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
323 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800324 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Tejun Heo16c55b02007-08-29 11:58:33 +0900325 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
Tejun Heoe31e8532007-09-23 13:14:13 +0900326 ATA_HORKAGE_SKIP_PM = (1 << 5), /* Skip PM operations */
Alan Cox93328e12007-09-29 04:06:48 -0400327 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
Alan Coxb3a70602007-10-02 12:38:26 -0400328
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400329 /* DMA mask for user DMA control: User visible values; DO NOT
Alan Coxb3a70602007-10-02 12:38:26 -0400330 renumber */
331 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
332 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
333 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334};
335
Albert Lee14be71f2005-09-27 17:36:35 +0800336enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800337 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800338 HSM_ST_FIRST, /* (waiting the device to)
339 write CDB or first data block */
Albert Leec56b14d22005-09-30 19:07:39 +0800340 HSM_ST, /* (waiting the device to) transfer data */
341 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800342 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343};
344
Jeff Garzika7dac442005-10-30 04:44:42 -0500345enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900346 AC_ERR_DEV = (1 << 0), /* device reported error */
347 AC_ERR_HSM = (1 << 1), /* host state machine violation */
348 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
349 AC_ERR_MEDIA = (1 << 3), /* media error */
350 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
351 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
352 AC_ERR_SYSTEM = (1 << 6), /* system error */
353 AC_ERR_INVALID = (1 << 7), /* invalid argument */
354 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900355 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Tejun Heo5335b722007-07-16 14:29:40 +0900356 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
Jeff Garzika7dac442005-10-30 04:44:42 -0500357};
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359/* forward declarations */
360struct scsi_device;
361struct ata_port_operations;
362struct ata_port;
Tejun Heocc0680a2007-08-06 18:36:23 +0900363struct ata_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364struct ata_queued_cmd;
365
366/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900367typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heocc0680a2007-08-06 18:36:23 +0900368typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
369typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900370 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900371typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900374 void __iomem *cmd_addr;
375 void __iomem *data_addr;
376 void __iomem *error_addr;
377 void __iomem *feature_addr;
378 void __iomem *nsect_addr;
379 void __iomem *lbal_addr;
380 void __iomem *lbam_addr;
381 void __iomem *lbah_addr;
382 void __iomem *device_addr;
383 void __iomem *status_addr;
384 void __iomem *command_addr;
385 void __iomem *altstatus_addr;
386 void __iomem *ctl_addr;
387 void __iomem *bmdma_addr;
388 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389};
390
Jeff Garzikcca39742006-08-24 03:19:22 -0400391struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 spinlock_t lock;
393 struct device *dev;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900394 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 unsigned int n_ports;
396 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400397 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100398 unsigned long flags;
Tejun Heofafbae82007-05-15 03:28:16 +0900399#ifdef CONFIG_ATA_ACPI
400 acpi_handle acpi_handle;
401#endif
Alan032af1c2007-03-01 17:36:46 +0000402 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900403 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404};
405
406struct ata_queued_cmd {
407 struct ata_port *ap;
408 struct ata_device *dev;
409
410 struct scsi_cmnd *scsicmd;
411 void (*scsidone)(struct scsi_cmnd *);
412
413 struct ata_taskfile tf;
414 u8 cdb[ATAPI_CDB_LEN];
415
416 unsigned long flags; /* ATA_QCFLAG_xxx */
417 unsigned int tag;
418 unsigned int n_elem;
Jens Axboe87260212007-10-16 11:14:12 +0200419 unsigned int n_iter;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400420 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422 int dma_dir;
423
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400424 unsigned int pad_len;
Mark Lord5a5dbd12007-03-16 10:22:26 -0400425 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 unsigned int nbytes;
428 unsigned int curbytes;
429
Jens Axboe87260212007-10-16 11:14:12 +0200430 struct scatterlist *cursg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 unsigned int cursg_ofs;
432
433 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400434 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 void *buf_virt;
436
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400437 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
438 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Albert Leea22e2eb2005-12-05 15:38:02 +0800440 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900441 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 ata_qc_cb_t complete_fn;
443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800445 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446};
447
Jeff Garzikcca39742006-08-24 03:19:22 -0400448struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 unsigned long unhandled_irq;
450 unsigned long idle_irq;
451 unsigned long rw_reqbuf;
452};
453
Tejun Heo0c247c52006-05-15 20:58:19 +0900454struct ata_ering_entry {
455 int is_io;
456 unsigned int err_mask;
457 u64 timestamp;
458};
459
460struct ata_ering {
461 int cursor;
462 struct ata_ering_entry ring[ATA_ERING_SIZE];
463};
464
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465struct ata_device {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900466 struct ata_link *link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 unsigned int devno; /* 0 or 1 */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900468 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo75683fe2007-07-05 13:31:27 +0900469 unsigned int horkage; /* List of broken features */
Tejun Heo3edebac2006-05-31 18:27:40 +0900470 struct scsi_device *sdev; /* attached SCSI device */
Tejun Heofafbae82007-05-15 03:28:16 +0900471#ifdef CONFIG_ATA_ACPI
472 acpi_handle acpi_handle;
473#endif
Tejun Heo72fa4b72006-05-31 18:27:32 +0900474 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
475 u64 n_sectors; /* size of device, if ATA */
476 unsigned int class; /* ATA_DEV_xxx */
Tejun Heoe0a71752007-09-23 13:14:12 +0900477
478 union {
479 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
480 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
481 };
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 u8 pio_mode;
484 u8 dma_mode;
485 u8 xfer_mode;
486 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
487
Albert Lee8cbd6df2005-10-12 15:06:27 +0800488 unsigned int multi_count; /* sectors count for
489 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900490 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900491 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400492
Tejun Heoacf356b2006-03-24 14:07:50 +0900493 /* per-dev xfer mask */
494 unsigned int pio_mask;
495 unsigned int mwdma_mask;
496 unsigned int udma_mask;
497
Albert Lee8bf62ece2005-05-12 15:29:42 -0400498 /* for CHS addressing */
499 u16 cylinders; /* Number of cylinders */
500 u16 heads; /* Number of heads */
501 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900502
503 /* error history */
504 struct ata_ering ering;
Tejun Heo7d47e8d2007-02-02 16:22:31 +0900505 int spdn_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506};
507
Tejun Heo72fa4b72006-05-31 18:27:32 +0900508/* Offset into struct ata_device. Fields above it are maintained
509 * acress device init. Fields below are zeroed.
510 */
511#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
512
Tejun Heof3e81b12006-05-15 20:58:21 +0900513struct ata_eh_info {
514 struct ata_device *dev; /* offending device */
515 u32 serror; /* SError from LLDD */
516 unsigned int err_mask; /* port-wide err_mask */
517 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900518 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900519 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900520
Tejun Heoabdda732006-05-31 18:27:29 +0900521 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
Tejun Heo64578a32007-05-15 03:28:16 +0900534struct ata_acpi_drive
535{
536 u32 pio;
537 u32 dma;
538} __packed;
539
540struct ata_acpi_gtm {
541 struct ata_acpi_drive drive[2];
542 u32 flags;
543} __packed;
544
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900545struct ata_link {
546 struct ata_port *ap;
Tejun Heo89898052007-08-06 18:36:23 +0900547 int pmp; /* port multiplier port # */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900548
549 unsigned int active_tag; /* active tag on this link */
550 u32 sactive; /* active NCQ commands */
551
Tejun Heo0c887582007-08-06 18:36:23 +0900552 unsigned int flags; /* ATA_LFLAG_xxx */
553
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900554 unsigned int hw_sata_spd_limit;
555 unsigned int sata_spd_limit;
556 unsigned int sata_spd; /* current SATA PHY speed */
557
558 /* record runtime error info, protected by host_set lock */
559 struct ata_eh_info eh_info;
560 /* EH context */
561 struct ata_eh_context eh_context;
562
563 struct ata_device device[ATA_MAX_DEVICES];
564};
565
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400567 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400568 const struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400569 spinlock_t *lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 unsigned long flags; /* ATA_FLAG_xxx */
Tejun Heob51e9e52006-06-29 01:29:30 +0900571 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900572 unsigned int print_id; /* user visible unique port ID */
573 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
575 struct ata_prd *prd; /* our SG list */
576 dma_addr_t prd_dma; /* and its DMA mapping */
577
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400578 void *pad; /* array of DMA pad buffers */
579 dma_addr_t pad_dma;
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
582
583 u8 ctl; /* cache of ATA control register */
584 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 unsigned int pio_mask;
586 unsigned int mwdma_mask;
587 unsigned int udma_mask;
588 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
590 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900591 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900592 unsigned int qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +0900593 int nr_active_links; /* #links with active qcs */
Tejun Heodedaf2b2006-05-15 21:03:43 +0900594
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900595 struct ata_link link; /* host default link */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Tejun Heo89898052007-08-06 18:36:23 +0900597 int nr_pmp_links; /* nr of available PMP links */
598 struct ata_link *pmp_link; /* array of PMP links */
Tejun Heoda917d62007-09-23 13:14:12 +0900599 struct ata_link *excl_link; /* for PMP qc exclusion */
Tejun Heo89898052007-08-06 18:36:23 +0900600
Jeff Garzikcca39742006-08-24 03:19:22 -0400601 struct ata_port_stats stats;
602 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600603 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
David Howells65f27f32006-11-22 14:55:48 +0000605 void *port_task_data;
David Howells52bad642006-11-22 14:54:01 +0000606 struct delayed_work port_task;
607 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400608 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900609
Albert Lee14be71f2005-09-27 17:36:35 +0800610 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Randy Dunlapbfd60572006-01-17 19:34:42 -0500612 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900613 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900614 wait_queue_head_t eh_wait_q;
Tejun Heoa1e10f72007-08-18 13:28:49 +0900615 int eh_tries;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500616
Tejun Heo500530f2006-07-03 16:07:27 +0900617 pm_message_t pm_mesg;
618 int *pm_result;
619
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900620 struct timer_list fastdrain_timer;
621 unsigned long fastdrain_cnt;
622
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900624
Tejun Heofafbae82007-05-15 03:28:16 +0900625#ifdef CONFIG_ATA_ACPI
626 acpi_handle acpi_handle;
Tejun Heo64578a32007-05-15 03:28:16 +0900627 struct ata_acpi_gtm acpi_gtm;
Tejun Heofafbae82007-05-15 03:28:16 +0900628#endif
Tejun Heofe635c72006-05-15 20:57:35 +0900629 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630};
631
632struct ata_port_operations {
Alancd0d3bb2007-03-02 00:56:15 +0000633 void (*dev_config) (struct ata_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
635 void (*set_piomode) (struct ata_port *, struct ata_device *);
636 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Coxa76b62c2007-03-09 09:34:07 -0500637 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Jeff Garzik057ace52005-10-22 14:27:05 -0400639 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
641
Jeff Garzik057ace52005-10-22 14:27:05 -0400642 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 u8 (*check_status)(struct ata_port *ap);
644 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 void (*dev_select)(struct ata_port *ap, unsigned int device);
646
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900647 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Tejun Heo02607312007-08-06 18:36:23 +0900648 int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900649
Alan Coxbe0d18d2007-03-06 02:37:56 -0800650 int (*cable_detect) (struct ata_port *ap);
651
Alanb229a7b2007-01-24 11:47:07 +0000652 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
654 void (*bmdma_setup) (struct ata_queued_cmd *qc);
655 void (*bmdma_start) (struct ata_queued_cmd *qc);
656
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100657 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
658
Tejun Heo31cc23b2007-09-23 13:14:12 +0900659 int (*qc_defer) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900661 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Tejun Heoe0a71752007-09-23 13:14:12 +0900663 /* port multiplier */
664 void (*pmp_attach) (struct ata_port *ap);
665 void (*pmp_detach) (struct ata_port *ap);
Tejun Heoe0a71752007-09-23 13:14:12 +0900666
Tejun Heo9ec957f2006-05-15 20:57:58 +0900667 /* Error handlers. ->error_handler overrides ->eng_timeout and
668 * indicates that new-style EH is in place.
669 */
670 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
671
672 void (*freeze) (struct ata_port *ap);
673 void (*thaw) (struct ata_port *ap);
674 void (*error_handler) (struct ata_port *ap);
675 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
David Howells7d12e782006-10-05 14:55:46 +0100677 irq_handler_t irq_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 void (*irq_clear) (struct ata_port *);
Akira Iguchi83625002007-01-26 16:27:32 +0900679 u8 (*irq_on) (struct ata_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Tejun Heoda3dbb12007-07-16 14:29:40 +0900681 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
682 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Tejun Heo500530f2006-07-03 16:07:27 +0900684 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
685 int (*port_resume) (struct ata_port *ap);
686
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 int (*port_start) (struct ata_port *ap);
688 void (*port_stop) (struct ata_port *ap);
689
Jeff Garzikcca39742006-08-24 03:19:22 -0400690 void (*host_stop) (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
Alan Coxb73fc892005-08-26 16:03:19 +0100692 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 u8 (*bmdma_status) (struct ata_port *ap);
694};
695
696struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100697 struct scsi_host_template *sht;
Jeff Garzikcca39742006-08-24 03:19:22 -0400698 unsigned long flags;
Tejun Heo0c887582007-08-06 18:36:23 +0900699 unsigned long link_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 unsigned long pio_mask;
701 unsigned long mwdma_mask;
702 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400703 const struct ata_port_operations *port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900704 irq_handler_t irq_handler;
Alan Coxe99f8b52005-11-08 14:09:44 +0000705 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706};
707
Alan Cox452503f2005-10-21 19:01:32 -0400708struct ata_timing {
709 unsigned short mode; /* ATA mode */
710 unsigned short setup; /* t1 */
711 unsigned short act8b; /* t2 for 8-bit I/O */
712 unsigned short rec8b; /* t2i for 8-bit I/O */
713 unsigned short cyc8b; /* t0 for 8-bit I/O */
714 unsigned short active; /* t2 or tD */
715 unsigned short recover; /* t2i or tK */
716 unsigned short cycle; /* t0 */
717 unsigned short udma; /* t2CYCTYP/2 */
718};
719
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400720#define FIT(v, vmin, vmax) max_t(short, min_t(short, v, vmax), vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Tejun Heoe9c83912006-07-03 16:07:26 +0900722extern const unsigned long sata_deb_timing_normal[];
723extern const unsigned long sata_deb_timing_hotplug[];
724extern const unsigned long sata_deb_timing_long[];
725
Tejun Heodd5b06c2006-08-10 16:59:12 +0900726extern const struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900727extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900728
Tejun Heoe9c83912006-07-03 16:07:26 +0900729static inline const unsigned long *
730sata_ehc_deb_timing(struct ata_eh_context *ehc)
731{
732 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
733 return sata_deb_timing_hotplug;
734 else
735 return sata_deb_timing_normal;
736}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900737
Tejun Heodd5b06c2006-08-10 16:59:12 +0900738static inline int ata_port_is_dummy(struct ata_port *ap)
739{
740 return ap->ops == &ata_dummy_port_ops;
741}
742
Tejun Heo936fd732007-08-06 18:36:23 +0900743extern void sata_print_link_status(struct ata_link *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744extern void ata_port_probe(struct ata_port *);
745extern void __sata_phy_reset(struct ata_port *ap);
746extern void sata_phy_reset(struct ata_port *ap);
747extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo936fd732007-08-06 18:36:23 +0900748extern int sata_set_spd(struct ata_link *link);
749extern int sata_link_debounce(struct ata_link *link,
750 const unsigned long *params, unsigned long deadline);
751extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
752 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900753extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
754extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900755 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900756extern int sata_link_hardreset(struct ata_link *link,
757 const unsigned long *timing, unsigned long deadline);
758extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900759 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900760extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761extern void ata_port_disable(struct ata_port *);
762extern void ata_std_ports(struct ata_ioports *ioaddr);
Jeff Garzik28555682007-10-11 17:12:35 -0400763
Tejun Heof3187192007-04-17 23:44:07 +0900764extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +0900765extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
766 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heoecef7252007-04-17 23:44:06 +0900767extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +0900768extern int ata_host_register(struct ata_host *host,
769 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +0900770extern int ata_host_activate(struct ata_host *host, int irq,
771 irq_handler_t irq_handler, unsigned long irq_flags,
772 struct scsi_host_template *sht);
Tejun Heo0529c152007-01-20 16:00:26 +0900773extern void ata_host_detach(struct ata_host *host);
Jeff Garzikcca39742006-08-24 03:19:22 -0400774extern void ata_host_init(struct ata_host *, struct device *,
775 unsigned long, const struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -0500776extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
778extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Brian King80289162006-08-07 14:27:31 -0500779extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400780extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500781 struct ata_port_info *, struct Scsi_Host *);
782extern int ata_sas_port_init(struct ata_port *);
783extern int ata_sas_port_start(struct ata_port *ap);
784extern void ata_sas_port_stop(struct ata_port *ap);
785extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
786extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
787 struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo936fd732007-08-06 18:36:23 +0900789extern int sata_scr_valid(struct ata_link *link);
790extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
791extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
792extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
793extern int ata_link_online(struct ata_link *link);
794extern int ata_link_offline(struct ata_link *link);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900795#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -0400796extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
797extern void ata_host_resume(struct ata_host *host);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900798#endif
Jeff Garzik67846b32005-10-05 02:58:32 -0400799extern int ata_ratelimit(void);
Tejun Heod1adc1b2006-10-09 18:32:15 +0900800extern int ata_busy_sleep(struct ata_port *ap,
801 unsigned long timeout_pat, unsigned long timeout);
Tejun Heod4b2bab2007-02-02 16:50:52 +0900802extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
David Howells65f27f32006-11-22 14:55:48 +0000803extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
Tejun Heo86e45b62006-03-05 15:29:09 +0900804 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900805extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
806 unsigned long interval_msec,
807 unsigned long timeout_msec);
Tejun Heo3f198592007-09-02 23:23:57 +0900808extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
809 u8 *r_err);
Jeff Garzik67846b32005-10-05 02:58:32 -0400810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811/*
812 * Default driver ops implementations
813 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400814extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Tejun Heo99771262007-07-16 14:29:38 +0900816extern void ata_tf_to_fis(const struct ata_taskfile *tf,
817 u8 pmp, int is_cmd, u8 *fis);
Jeff Garzik057ace52005-10-22 14:27:05 -0400818extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400819extern void ata_noop_dev_select(struct ata_port *ap, unsigned int device);
820extern void ata_std_dev_select(struct ata_port *ap, unsigned int device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821extern u8 ata_check_status(struct ata_port *ap);
822extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400823extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400824extern int ata_port_start(struct ata_port *ap);
825extern int ata_sff_port_start(struct ata_port *ap);
826extern irqreturn_t ata_interrupt(int irq, void *dev_instance);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900827extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
828 unsigned int buflen, int write_data);
829extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
830 unsigned int buflen, int write_data);
Tejun Heo31cc23b2007-09-23 13:14:12 +0900831extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
Alan Coxd26fc952007-07-06 19:13:52 -0400832extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600834extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900835extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
837 unsigned int buflen);
838extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
839 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400840extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +0000841extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +0900842extern void ata_id_string(const u16 *id, unsigned char *s,
843 unsigned int ofs, unsigned int len);
844extern void ata_id_c_string(const u16 *id, unsigned char *s,
845 unsigned int ofs, unsigned int len);
Alan10305f02007-02-20 18:01:59 +0000846extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400847extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
848extern void ata_bmdma_start(struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100849extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850extern u8 ata_bmdma_status(struct ata_port *ap);
851extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900852extern void ata_bmdma_freeze(struct ata_port *ap);
853extern void ata_bmdma_thaw(struct ata_port *ap);
Tejun Heof5914a42006-05-31 18:27:48 +0900854extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900855 ata_reset_fn_t softreset,
856 ata_reset_fn_t hardreset,
857 ata_postreset_fn_t postreset);
858extern void ata_bmdma_error_handler(struct ata_port *ap);
859extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo9a1004d2006-05-31 18:27:52 +0900860extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
861 u8 status, int in_wq);
Tejun Heof686bcb2006-05-15 20:58:05 +0900862extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900863extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
864 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900865extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 void (*done)(struct scsi_cmnd *));
867extern int ata_std_bios_param(struct scsi_device *sdev,
868 struct block_device *bdev,
869 sector_t capacity, int geom[]);
870extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900871extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900872extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
873 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900874extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Tejun Heo02607312007-08-06 18:36:23 +0900875extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
Akira Iguchi83625002007-01-26 16:27:32 +0900876extern u8 ata_irq_on(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
Alan Coxbe0d18d2007-03-06 02:37:56 -0800878extern int ata_cable_40wire(struct ata_port *ap);
879extern int ata_cable_80wire(struct ata_port *ap);
880extern int ata_cable_sata(struct ata_port *ap);
881extern int ata_cable_unknown(struct ata_port *ap);
882
Alan Cox452503f2005-10-21 19:01:32 -0400883/*
884 * Timing helpers
885 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000886
887extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400888extern int ata_timing_compute(struct ata_device *, unsigned short,
889 struct ata_timing *, int, int);
890extern void ata_timing_merge(const struct ata_timing *,
891 const struct ata_timing *, struct ata_timing *,
892 unsigned int);
893
894enum {
895 ATA_TIMING_SETUP = (1 << 0),
896 ATA_TIMING_ACT8B = (1 << 1),
897 ATA_TIMING_REC8B = (1 << 2),
898 ATA_TIMING_CYC8B = (1 << 3),
899 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
900 ATA_TIMING_CYC8B,
901 ATA_TIMING_ACTIVE = (1 << 4),
902 ATA_TIMING_RECOVER = (1 << 5),
903 ATA_TIMING_CYCLE = (1 << 6),
904 ATA_TIMING_UDMA = (1 << 7),
905 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
906 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
907 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
908 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
909};
910
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400911/* libata-acpi.c */
912#ifdef CONFIG_ATA_ACPI
913extern int ata_acpi_cbl_80wire(struct ata_port *ap);
Alan Coxbadff032007-10-04 21:28:18 +0100914int ata_acpi_stm(const struct ata_port *ap, struct ata_acpi_gtm *stm);
915int ata_acpi_gtm(const struct ata_port *ap, struct ata_acpi_gtm *stm);
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400916#else
917static inline int ata_acpi_cbl_80wire(struct ata_port *ap) { return 0; }
918#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
920#ifdef CONFIG_PCI
Jeff Garzik28555682007-10-11 17:12:35 -0400921struct pci_dev;
922
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400923extern int ata_pci_init_one(struct pci_dev *pdev,
Jeff Garzik28555682007-10-11 17:12:35 -0400924 const struct ata_port_info * const * ppi);
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400925extern void ata_pci_remove_one(struct pci_dev *pdev);
Jeff Garzik28555682007-10-11 17:12:35 -0400926#ifdef CONFIG_PM
927extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
928extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
929extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
930extern int ata_pci_device_resume(struct pci_dev *pdev);
931#endif
932extern int ata_pci_clear_simplex(struct pci_dev *pdev);
933
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934struct pci_bits {
935 unsigned int reg; /* PCI config register to read */
936 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
937 unsigned long mask;
938 unsigned long val;
939};
940
Tejun Heod583bc12007-07-04 18:02:07 +0900941extern int ata_pci_init_sff_host(struct ata_host *host);
Tejun Heo1626aeb2007-05-04 12:43:58 +0200942extern int ata_pci_init_bmdma(struct ata_host *host);
Tejun Heod583bc12007-07-04 18:02:07 +0900943extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
944 const struct ata_port_info * const * ppi,
945 struct ata_host **r_host);
Jeff Garzik057ace52005-10-22 14:27:05 -0400946extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Alan Coxa76b62c2007-03-09 09:34:07 -0500947extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948#endif /* CONFIG_PCI */
949
Tejun Heoece1d632006-04-02 18:51:53 +0900950/*
Tejun Heo3af9a772007-09-23 13:19:54 +0900951 * PMP
952 */
Tejun Heo31f88382007-09-23 13:19:54 +0900953extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
Tejun Heo3af9a772007-09-23 13:19:54 +0900954extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline);
955extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class,
956 unsigned long deadline);
957extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class);
958extern void sata_pmp_do_eh(struct ata_port *ap,
959 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
960 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset,
961 ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset,
962 ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset);
963
964/*
Tejun Heoece1d632006-04-02 18:51:53 +0900965 * EH
966 */
Tejun Heoece1d632006-04-02 18:51:53 +0900967extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900968
969extern void ata_port_schedule_eh(struct ata_port *ap);
Tejun Heodbd82612007-08-06 18:36:23 +0900970extern int ata_link_abort(struct ata_link *link);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900971extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900972extern int ata_port_freeze(struct ata_port *ap);
Tejun Heo7d77b242007-09-23 13:14:13 +0900973extern int sata_async_notification(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900974
975extern void ata_eh_freeze_port(struct ata_port *ap);
976extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900977
Tejun Heoece1d632006-04-02 18:51:53 +0900978extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
979extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
980
Tejun Heof5914a42006-05-31 18:27:48 +0900981extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
982 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
983 ata_postreset_fn_t postreset);
Tejun Heo022bdb02006-05-15 20:58:22 +0900984
Tejun Heo61440db2006-05-15 20:57:55 +0900985/*
986 * printk helpers
987 */
988#define ata_port_printk(ap, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900989 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Tejun Heo89898052007-08-06 18:36:23 +0900991#define ata_link_printk(link, lv, fmt, args...) do { \
992 if ((link)->ap->nr_pmp_links) \
993 printk(lv"ata%u.%02u: "fmt, (link)->ap->print_id, \
994 (link)->pmp , ##args); \
995 else \
996 printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args); \
997 } while(0)
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900998
Tejun Heo61440db2006-05-15 20:57:55 +0900999#define ata_dev_printk(dev, lv, fmt, args...) \
Tejun Heo89898052007-08-06 18:36:23 +09001000 printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, \
1001 (dev)->link->pmp + (dev)->devno , ##args)
Tejun Heo61440db2006-05-15 20:57:55 +09001002
1003/*
Tejun Heof3e81b12006-05-15 20:58:21 +09001004 * ata_eh_info helpers
1005 */
Tejun Heocb94c1c2007-07-30 14:24:15 +09001006extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1007 __attribute__ ((format (printf, 2, 3)));
1008extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1009 __attribute__ ((format (printf, 2, 3)));
Tejun Heob64bbc32007-07-16 14:29:39 +09001010extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
Tejun Heof3e81b12006-05-15 20:58:21 +09001011
Tejun Heof8f1e1c2007-07-16 14:29:40 +09001012static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
Tejun Heo084fe632006-05-31 18:28:03 +09001013{
Tejun Heof8f1e1c2007-07-16 14:29:40 +09001014 ehi->flags |= ATA_EHI_RESUME_LINK;
Tejun Heo084fe632006-05-31 18:28:03 +09001015 ehi->action |= ATA_EH_SOFTRESET;
1016 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1017}
1018
Tejun Heoc0b6c032006-07-03 16:07:26 +09001019static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1020{
Tejun Heof8f1e1c2007-07-16 14:29:40 +09001021 ata_ehi_schedule_probe(ehi);
1022 ehi->flags |= ATA_EHI_HOTPLUGGED;
Tejun Heof9df58c2007-09-23 13:14:13 +09001023 ehi->action |= ATA_EH_ENABLE_LINK;
Tejun Heoc0b6c032006-07-03 16:07:26 +09001024 ehi->err_mask |= AC_ERR_ATA_BUS;
1025}
1026
Tejun Heof3e81b12006-05-15 20:58:21 +09001027/*
Tejun Heocbcdd872007-08-18 13:14:55 +09001028 * port description helpers
1029 */
1030extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1031 __attribute__ ((format (printf, 2, 3)));
1032#ifdef CONFIG_PCI
1033extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1034 const char *name);
1035#endif
1036
1037/*
Tejun Heo61440db2006-05-15 20:57:55 +09001038 * qc helpers
1039 */
Jeff Garzikcedc9a42005-10-05 07:13:30 -04001040static inline struct scatterlist *
Tejun Heocc1887f32006-02-20 23:48:38 +09001041ata_qc_first_sg(struct ata_queued_cmd *qc)
1042{
Jens Axboe87260212007-10-16 11:14:12 +02001043 qc->n_iter = 0;
Tejun Heocc1887f32006-02-20 23:48:38 +09001044 if (qc->n_elem)
1045 return qc->__sg;
1046 if (qc->pad_len)
1047 return &qc->pad_sgent;
1048 return NULL;
1049}
1050
1051static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -04001052ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
1053{
1054 if (sg == &qc->pad_sgent)
1055 return NULL;
Jens Axboe87260212007-10-16 11:14:12 +02001056 if (++qc->n_iter < qc->n_elem)
1057 return sg_next(sg);
Tejun Heocc1887f32006-02-20 23:48:38 +09001058 if (qc->pad_len)
1059 return &qc->pad_sgent;
1060 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -04001061}
1062
1063#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f32006-02-20 23:48:38 +09001064 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -04001065
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066static inline unsigned int ata_tag_valid(unsigned int tag)
1067{
1068 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1069}
1070
Tejun Heo2ab7db12006-05-15 20:58:02 +09001071static inline unsigned int ata_tag_internal(unsigned int tag)
1072{
1073 return tag == ATA_MAX_QUEUE - 1;
1074}
1075
Tejun Heo5806db22006-06-24 20:30:19 +09001076/*
1077 * device helpers
1078 */
Tejun Heoe1211e32006-04-01 01:38:18 +09001079static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +09001080{
Tejun Heoe0a71752007-09-23 13:14:12 +09001081 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1082 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
Tejun Heo597afd22006-03-01 01:25:38 +09001083}
1084
Tejun Heoe1211e32006-04-01 01:38:18 +09001085static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086{
Tejun Heoe0a71752007-09-23 13:14:12 +09001087 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1088 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
Tejun Heoe1211e32006-04-01 01:38:18 +09001089}
1090
Tejun Heo002c8052006-04-02 17:54:46 +09001091static inline unsigned int ata_class_absent(unsigned int class)
1092{
1093 return !ata_class_enabled(class) && !ata_class_disabled(class);
1094}
1095
Tejun Heoe1211e32006-04-01 01:38:18 +09001096static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1097{
1098 return ata_class_enabled(dev->class);
1099}
1100
1101static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1102{
1103 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104}
1105
Tejun Heo002c8052006-04-02 17:54:46 +09001106static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1107{
1108 return ata_class_absent(dev->class);
1109}
1110
Tejun Heo5806db22006-06-24 20:30:19 +09001111/*
Tejun Heof58229f2007-08-06 18:36:23 +09001112 * link helpers
Tejun Heo5806db22006-06-24 20:30:19 +09001113 */
Tejun Heo89898052007-08-06 18:36:23 +09001114static inline int ata_is_host_link(const struct ata_link *link)
1115{
1116 return link == &link->ap->link;
1117}
1118
Tejun Heof58229f2007-08-06 18:36:23 +09001119static inline int ata_link_max_devices(const struct ata_link *link)
Tejun Heo5806db22006-06-24 20:30:19 +09001120{
Tejun Heo89898052007-08-06 18:36:23 +09001121 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
Tejun Heo5806db22006-06-24 20:30:19 +09001122 return 2;
1123 return 1;
1124}
1125
Tejun Heoda917d62007-09-23 13:14:12 +09001126static inline int ata_link_active(struct ata_link *link)
1127{
1128 return ata_tag_valid(link->active_tag) || link->sactive;
1129}
1130
Tejun Heo89898052007-08-06 18:36:23 +09001131static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1132{
1133 if (ap->nr_pmp_links)
1134 return ap->pmp_link;
1135 return &ap->link;
1136}
1137
1138static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1139{
1140 struct ata_port *ap = link->ap;
1141
1142 if (link == &ap->link) {
1143 if (!ap->nr_pmp_links)
1144 return NULL;
1145 return ap->pmp_link;
1146 }
1147
1148 if (++link - ap->pmp_link < ap->nr_pmp_links)
1149 return link;
1150 return NULL;
1151}
1152
1153#define __ata_port_for_each_link(lk, ap) \
1154 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1155
1156#define ata_port_for_each_link(link, ap) \
1157 for ((link) = ata_port_first_link(ap); (link); \
1158 (link) = ata_port_next_link(link))
Tejun Heof58229f2007-08-06 18:36:23 +09001159
1160#define ata_link_for_each_dev(dev, link) \
1161 for ((dev) = (link)->device; \
1162 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1163 (dev)++)
1164
1165#define ata_link_for_each_dev_reverse(dev, link) \
1166 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1167 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
Tejun Heo5806db22006-06-24 20:30:19 +09001168
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169static inline u8 ata_chk_status(struct ata_port *ap)
1170{
1171 return ap->ops->check_status(ap);
1172}
1173
Tejun Heo6d1245b2007-02-20 23:20:27 +09001174/**
1175 * ata_ncq_enabled - Test whether NCQ is enabled
1176 * @dev: ATA device to test for
1177 *
1178 * LOCKING:
1179 * spin_lock_irqsave(host lock)
1180 *
1181 * RETURNS:
1182 * 1 if NCQ is enabled for @dev, 0 otherwise.
1183 */
1184static inline int ata_ncq_enabled(struct ata_device *dev)
1185{
1186 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1187 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1188}
Edward Falk0baab862005-06-02 18:17:13 -04001189
1190/**
1191 * ata_pause - Flush writes and pause 400 nanoseconds.
1192 * @ap: Port to wait for.
1193 *
1194 * LOCKING:
1195 * Inherited from caller.
1196 */
1197
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198static inline void ata_pause(struct ata_port *ap)
1199{
1200 ata_altstatus(ap);
1201 ndelay(400);
1202}
1203
Edward Falk0baab862005-06-02 18:17:13 -04001204
1205/**
1206 * ata_busy_wait - Wait for a port status register
1207 * @ap: Port to wait for.
Alan07777212007-01-31 17:47:24 +00001208 * @bits: bits that must be clear
1209 * @max: number of 10uS waits to perform
Edward Falk0baab862005-06-02 18:17:13 -04001210 *
1211 * Waits up to max*10 microseconds for the selected bits in the port's
1212 * status register to be cleared.
1213 * Returns final value of status register.
1214 *
1215 * LOCKING:
1216 * Inherited from caller.
1217 */
1218
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1220 unsigned int max)
1221{
1222 u8 status;
1223
1224 do {
1225 udelay(10);
1226 status = ata_chk_status(ap);
1227 max--;
Tejun Heod1adc1b2006-10-09 18:32:15 +09001228 } while (status != 0xff && (status & bits) && (max > 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229
1230 return status;
1231}
1232
Edward Falk0baab862005-06-02 18:17:13 -04001233
1234/**
1235 * ata_wait_idle - Wait for a port to be idle.
1236 * @ap: Port to wait for.
1237 *
1238 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1239 * Returns final value of status register.
1240 *
1241 * LOCKING:
1242 * Inherited from caller.
1243 */
1244
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245static inline u8 ata_wait_idle(struct ata_port *ap)
1246{
1247 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1248
Tejun Heo15529452007-07-30 14:23:03 +09001249#ifdef ATA_DEBUG
Tejun Heo55f39522007-06-25 21:31:05 +09001250 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
Tejun Heo15529452007-07-30 14:23:03 +09001251 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1252 status);
1253#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
1255 return status;
1256}
1257
1258static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1259{
1260 qc->tf.ctl |= ATA_NIEN;
1261}
1262
Tejun Heof69499f2006-05-15 20:58:03 +09001263static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1264 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265{
1266 if (likely(ata_tag_valid(tag)))
1267 return &ap->qcmd[tag];
1268 return NULL;
1269}
1270
Tejun Heof69499f2006-05-15 20:58:03 +09001271static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1272 unsigned int tag)
1273{
1274 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1275
1276 if (unlikely(!qc) || !ap->ops->error_handler)
1277 return qc;
1278
1279 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1280 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1281 return qc;
1282
1283 return NULL;
1284}
1285
Tejun Heo3373efd2006-05-15 20:57:53 +09001286static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287{
1288 memset(tf, 0, sizeof(*tf));
1289
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001290 tf->ctl = dev->link->ap->ctl;
Tejun Heo3373efd2006-05-15 20:57:53 +09001291 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 tf->device = ATA_DEVICE_OBS;
1293 else
1294 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1295}
1296
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001297static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1298{
Tejun Heo501e0c502007-01-17 11:34:02 +09001299 qc->dma_dir = DMA_NONE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001300 qc->__sg = NULL;
1301 qc->flags = 0;
Jens Axboe87260212007-10-16 11:14:12 +02001302 qc->cursg = NULL;
1303 qc->cursg_ofs = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001304 qc->nbytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001305 qc->n_elem = 0;
Jens Axboe87260212007-10-16 11:14:12 +02001306 qc->n_iter = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001307 qc->err_mask = 0;
Brian Kingd0f29482007-01-17 12:32:28 -06001308 qc->pad_len = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001309 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001310
Tejun Heo3373efd2006-05-15 20:57:53 +09001311 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001312
1313 /* init result_tf such that it indicates normal completion */
1314 qc->result_tf.command = ATA_DRDY;
1315 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001316}
1317
Jeff Garzik057ace52005-10-22 14:27:05 -04001318static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319{
1320 return ata_id_wcache_enabled(dev->id) ||
1321 ata_id_has_flush(dev->id) ||
1322 ata_id_has_flush_ext(dev->id);
1323}
1324
Jeff Garzika7dac442005-10-30 04:44:42 -05001325static inline unsigned int ac_err_mask(u8 status)
1326{
Albert Lee3655d1d2006-05-19 11:43:04 +08001327 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001328 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001329 if (status & (ATA_ERR | ATA_DF))
1330 return AC_ERR_DEV;
1331 return 0;
1332}
1333
1334static inline unsigned int __ac_err_mask(u8 status)
1335{
1336 unsigned int mask = ac_err_mask(status);
1337 if (mask == 0)
1338 return AC_ERR_OTHER;
1339 return mask;
1340}
1341
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001342static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1343{
1344 ap->pad_dma = 0;
Tejun Heof0d36ef2007-01-20 16:00:28 +09001345 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1346 &ap->pad_dma, GFP_KERNEL);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001347 return (ap->pad == NULL) ? -ENOMEM : 0;
1348}
1349
1350static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1351{
Tejun Heof0d36ef2007-01-20 16:00:28 +09001352 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001353}
1354
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001355static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1356{
Tejun Heo49114872007-04-17 23:44:06 +09001357 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001358}
1359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360#endif /* __LINUX_LIBATA_H__ */