blob: 7a1793bd237144b866c72a7e00711017d53b2e71 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
3 * Copyright 2003-2005 Jeff Garzik
4 *
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
9 * any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19 *
20 *
21 * libata documentation is available via 'make {ps|pdf}docs',
22 * as Documentation/DocBook/libata.*
23 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 */
25
26#ifndef __LINUX_LIBATA_H__
27#define __LINUX_LIBATA_H__
28
29#include <linux/delay.h>
30#include <linux/interrupt.h>
31#include <linux/pci.h>
Andrew Morton1c72d8d2005-11-10 16:21:38 -080032#include <linux/dma-mapping.h>
Andrew Morton41542db2006-06-23 04:18:31 -070033#include <asm/scatterlist.h>
Tejun Heof0d36ef2007-01-20 16:00:28 +090034#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/ata.h>
36#include <linux/workqueue.h>
Jeff Garzik35bb94b2006-04-11 13:12:34 -040037#include <scsi/scsi_host.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070038#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Jeff Garzika6d967a2006-09-25 15:33:09 -040040/*
41 * Define if arch has non-standard setup. This is a _PCI_ standard
42 * not a legacy or ISA standard.
43 */
44#ifdef CONFIG_ATA_NONSTANDARD
Alan Cox2ec7df02006-08-10 16:59:10 +090045#include <asm/libata-portmap.h>
Jeff Garzika6d967a2006-09-25 15:33:09 -040046#else
47#include <asm-generic/libata-portmap.h>
48#endif
Alan Cox2ec7df02006-08-10 16:59:10 +090049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/*
Randy Dunlapbfd60572006-01-17 19:34:42 -050051 * compile-time options: to be removed as soon as all the drivers are
52 * converted to the new debugging mechanism
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 */
54#undef ATA_DEBUG /* debugging output */
55#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
56#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
57#undef ATA_NDEBUG /* define to disable quick runtime checks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59
60/* note: prints function name for you */
61#ifdef ATA_DEBUG
62#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
63#ifdef ATA_VERBOSE_DEBUG
64#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
65#else
66#define VPRINTK(fmt, args...)
67#endif /* ATA_VERBOSE_DEBUG */
68#else
69#define DPRINTK(fmt, args...)
70#define VPRINTK(fmt, args...)
71#endif /* ATA_DEBUG */
72
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050073#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
74
Randy Dunlapbfd60572006-01-17 19:34:42 -050075/* NEW: debug levels */
76#define HAVE_LIBATA_MSG 1
77
78enum {
79 ATA_MSG_DRV = 0x0001,
80 ATA_MSG_INFO = 0x0002,
81 ATA_MSG_PROBE = 0x0004,
82 ATA_MSG_WARN = 0x0008,
83 ATA_MSG_MALLOC = 0x0010,
84 ATA_MSG_CTL = 0x0020,
85 ATA_MSG_INTR = 0x0040,
86 ATA_MSG_ERR = 0x0080,
87};
88
89#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
90#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
91#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
92#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
93#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
94#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
95#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
96#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
97
98static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
99{
100 if (dval < 0 || dval >= (sizeof(u32) * 8))
101 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
102 if (!dval)
103 return 0;
104 return (1 << dval) - 1;
105}
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107/* defines only for the constants which don't work well as enums */
108#define ATA_TAG_POISON 0xfafbfcfdU
109
110/* move to PCI layer? */
111static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
112{
113 return &pdev->dev;
114}
115
116enum {
117 /* various global constants */
118 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
Alan Coxd26fc952007-07-06 19:13:52 -0400119 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 ATA_MAX_PORTS = 8,
121 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900122 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900123 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900124 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 ATA_MAX_BUS = 2,
126 ATA_DEF_BUSY_WAIT = 10000,
127 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
128
129 ATA_SHT_EMULATED = 1,
130 ATA_SHT_CMD_PER_LUN = 1,
131 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400132 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900135 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
136 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400137 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900138 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900139 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heo67465442007-05-15 03:28:16 +0900140 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
141 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
Tejun Heoea1dd4e2006-04-02 18:51:53 +0900142 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900143
Tejun Heoe5c9e082006-09-30 19:44:39 +0900144 ATA_DFLAG_PIO = (1 << 8), /* device limited to PIO mode */
Tejun Heo33435712006-10-19 14:44:53 +0900145 ATA_DFLAG_NCQ_OFF = (1 << 9), /* device limited to non-NCQ mode */
Tejun Heo13b8d092007-05-15 12:29:22 +0200146 ATA_DFLAG_SPUNDOWN = (1 << 10), /* XXX: for spindown_compat */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900147 ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Tejun Heoabdda732006-05-31 18:27:29 +0900149 ATA_DFLAG_DETACH = (1 << 16),
150 ATA_DFLAG_DETACHED = (1 << 17),
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 ATA_DEV_UNKNOWN = 0, /* unknown device */
153 ATA_DEV_ATA = 1, /* ATA device */
154 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
155 ATA_DEV_ATAPI = 3, /* ATAPI device */
156 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
157 ATA_DEV_NONE = 5, /* no device */
158
Tejun Heo0c887582007-08-06 18:36:23 +0900159 /* struct ata_link flags */
160 ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */
161 ATA_LFLAG_SKIP_D2H_BSY = (1 << 1), /* can't wait for the first D2H
162 * Register FIS clearing BSY */
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900165 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900167 ATA_FLAG_SATA = (1 << 1),
168 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
169 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
170 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
171 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
172 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
173 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
174 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900175 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
176 * doesn't handle PIO interrupts */
177 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Tejun Heo7395acb2006-05-31 18:27:25 +0900178 ATA_FLAG_DEBUGMSG = (1 << 13),
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900179 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800180 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Tejun Heo3cadbcc2007-05-15 03:28:15 +0900181 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
Jens Axboe9b847542006-01-06 09:28:07 +0100182
Tejun Heob51e9e52006-06-29 01:29:30 +0900183 /* The following flag belongs to ap->pflags but is kept in
184 * ap->flags because it's referenced in many LLDs and will be
185 * removed in not-too-distant future.
186 */
187 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900188
Tejun Heob51e9e52006-06-29 01:29:30 +0900189 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000190
Tejun Heob51e9e52006-06-29 01:29:30 +0900191 /* struct ata_port pflags */
192 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
193 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
194 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
195 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
196 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
197 ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
198 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
Tejun Heof4d6d002007-05-01 11:50:15 +0200199 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
Tejun Heob51e9e52006-06-29 01:29:30 +0900200
Tejun Heob51e9e52006-06-29 01:29:30 +0900201 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900202 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heo64578a32007-05-15 03:28:16 +0900203 ATA_PFLAG_GTM_VALID = (1 << 19), /* acpi_gtm data valid */
Tejun Heodde44582006-02-02 00:56:10 +0900204
Tejun Heo949b38a2006-04-02 18:51:52 +0900205 /* struct ata_queued_cmd flags */
206 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
207 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
208 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
Tejun Heo27197362006-04-02 18:51:53 +0900210 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900211 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
212
Tejun Heo9ec957f2006-05-15 20:57:58 +0900213 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
214 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
215 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100217 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400218 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900219 ATA_HOST_STARTED = (1 << 1), /* Host started */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400220
Tejun Heob8b275e2007-07-10 15:55:43 +0900221 /* bits 24:31 of host->flags are reserved for LLD specific flags */
222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 /* various lengths of time */
Alan Cox8d238e02006-01-17 20:50:31 +0000224 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
225 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
Tejun Heoa2a7a662005-12-13 14:48:31 +0900226 ATA_TMOUT_INTERNAL = 30 * HZ,
227 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229 /* ATA bus states */
230 BUS_UNKNOWN = 0,
231 BUS_DMA = 1,
232 BUS_IDLE = 2,
233 BUS_NOINTR = 3,
234 BUS_NODATA = 4,
235 BUS_TIMER = 5,
236 BUS_PIO = 6,
237 BUS_EDD = 7,
238 BUS_IDENTIFY = 8,
239 BUS_PACKET = 9,
240
241 /* SATA port states */
242 PORT_UNKNOWN = 0,
243 PORT_ENABLED = 1,
244 PORT_DISABLED = 2,
245
246 /* encoding various smaller bitmaps into a single
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900247 * unsigned int bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 */
Alan Coxb352e572006-08-10 18:52:12 +0100249 ATA_BITS_PIO = 7,
250 ATA_BITS_MWDMA = 5,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900251 ATA_BITS_UDMA = 8,
252
253 ATA_SHIFT_PIO = 0,
254 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
255 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
256
257 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
258 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
259 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400260
261 /* size of buffer to pad xfers ending on unaligned boundaries */
262 ATA_DMA_PAD_SZ = 4,
263 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
Tejun Heo949b38a2006-04-02 18:51:52 +0900264
Tejun Heo0c247c52006-05-15 20:58:19 +0900265 /* ering size */
266 ATA_ERING_SIZE = 32,
267
Tejun Heof3e81b12006-05-15 20:58:21 +0900268 /* desc_len for ata_eh_info and context */
269 ATA_EH_DESC_LEN = 80,
270
Tejun Heo9be1e972006-05-15 20:58:17 +0900271 /* reset / recovery action types */
272 ATA_EH_REVALIDATE = (1 << 0),
273 ATA_EH_SOFTRESET = (1 << 1),
274 ATA_EH_HARDRESET = (1 << 2),
275
276 ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heo9666f402007-05-04 21:27:47 +0200277 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
Tejun Heo9be1e972006-05-15 20:58:17 +0900278
Tejun Heof3e81b12006-05-15 20:58:21 +0900279 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900280 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo13abf502006-07-10 23:18:46 +0900281 ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900282 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
283 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900284
Tejun Heo0d64a232007-04-23 02:41:05 +0900285 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
286 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
287 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
288 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
289 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900290
Tejun Heo0d64a232007-04-23 02:41:05 +0900291 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900292 ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
293
Tejun Heoad9e2762006-05-15 20:58:12 +0900294 /* max repeat if error condition is still set after ->error_handler */
295 ATA_EH_MAX_REPEAT = 5,
296
Tejun Heo14d2bac2006-04-02 17:54:46 +0900297 /* how hard are we gonna try to probe/recover devices */
298 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900299 ATA_EH_DEV_TRIES = 3,
Tejun Heof5914a42006-05-31 18:27:48 +0900300
Alan Cox93590852006-09-12 16:55:12 +0100301 /* Horkage types. May be set by libata or controller on drives
302 (some horkage may be drive/controller pair dependant */
303
304 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700305 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
306 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800307 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Tejun Heo16c55b02007-08-29 11:58:33 +0900308 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309};
310
Albert Lee14be71f2005-09-27 17:36:35 +0800311enum hsm_task_states {
Albert Leec56b14d22005-09-30 19:07:39 +0800312 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800313 HSM_ST_FIRST, /* (waiting the device to)
314 write CDB or first data block */
Albert Leec56b14d22005-09-30 19:07:39 +0800315 HSM_ST, /* (waiting the device to) transfer data */
316 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d22005-09-30 19:07:39 +0800317 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318};
319
Jeff Garzika7dac442005-10-30 04:44:42 -0500320enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900321 AC_ERR_DEV = (1 << 0), /* device reported error */
322 AC_ERR_HSM = (1 << 1), /* host state machine violation */
323 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
324 AC_ERR_MEDIA = (1 << 3), /* media error */
325 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
326 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
327 AC_ERR_SYSTEM = (1 << 6), /* system error */
328 AC_ERR_INVALID = (1 << 7), /* invalid argument */
329 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900330 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Tejun Heo5335b722007-07-16 14:29:40 +0900331 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
Jeff Garzika7dac442005-10-30 04:44:42 -0500332};
333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334/* forward declarations */
335struct scsi_device;
336struct ata_port_operations;
337struct ata_port;
Tejun Heocc0680a2007-08-06 18:36:23 +0900338struct ata_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339struct ata_queued_cmd;
340
341/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900342typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heocc0680a2007-08-06 18:36:23 +0900343typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
344typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900345 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900346typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900349 void __iomem *cmd_addr;
350 void __iomem *data_addr;
351 void __iomem *error_addr;
352 void __iomem *feature_addr;
353 void __iomem *nsect_addr;
354 void __iomem *lbal_addr;
355 void __iomem *lbam_addr;
356 void __iomem *lbah_addr;
357 void __iomem *device_addr;
358 void __iomem *status_addr;
359 void __iomem *command_addr;
360 void __iomem *altstatus_addr;
361 void __iomem *ctl_addr;
362 void __iomem *bmdma_addr;
363 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364};
365
Jeff Garzikcca39742006-08-24 03:19:22 -0400366struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 spinlock_t lock;
368 struct device *dev;
369 unsigned long irq;
Alan Cox2ec7df02006-08-10 16:59:10 +0900370 unsigned long irq2;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900371 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 unsigned int n_ports;
373 void *private_data;
Jeff Garzik057ace52005-10-22 14:27:05 -0400374 const struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100375 unsigned long flags;
Tejun Heofafbae82007-05-15 03:28:16 +0900376#ifdef CONFIG_ATA_ACPI
377 acpi_handle acpi_handle;
378#endif
Alan032af1c2007-03-01 17:36:46 +0000379 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900380 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381};
382
383struct ata_queued_cmd {
384 struct ata_port *ap;
385 struct ata_device *dev;
386
387 struct scsi_cmnd *scsicmd;
388 void (*scsidone)(struct scsi_cmnd *);
389
390 struct ata_taskfile tf;
391 u8 cdb[ATAPI_CDB_LEN];
392
393 unsigned long flags; /* ATA_QCFLAG_xxx */
394 unsigned int tag;
395 unsigned int n_elem;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400396 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398 int dma_dir;
399
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400400 unsigned int pad_len;
Mark Lord5a5dbd12007-03-16 10:22:26 -0400401 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 unsigned int nbytes;
404 unsigned int curbytes;
405
406 unsigned int cursg;
407 unsigned int cursg_ofs;
408
409 struct scatterlist sgent;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400410 struct scatterlist pad_sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 void *buf_virt;
412
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400413 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
414 struct scatterlist *__sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Albert Leea22e2eb2005-12-05 15:38:02 +0800416 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900417 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 ata_qc_cb_t complete_fn;
419
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800421 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422};
423
Jeff Garzikcca39742006-08-24 03:19:22 -0400424struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 unsigned long unhandled_irq;
426 unsigned long idle_irq;
427 unsigned long rw_reqbuf;
428};
429
Tejun Heo0c247c52006-05-15 20:58:19 +0900430struct ata_ering_entry {
431 int is_io;
432 unsigned int err_mask;
433 u64 timestamp;
434};
435
436struct ata_ering {
437 int cursor;
438 struct ata_ering_entry ring[ATA_ERING_SIZE];
439};
440
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441struct ata_device {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900442 struct ata_link *link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 unsigned int devno; /* 0 or 1 */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900444 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo75683fe2007-07-05 13:31:27 +0900445 unsigned int horkage; /* List of broken features */
Tejun Heo3edebac2006-05-31 18:27:40 +0900446 struct scsi_device *sdev; /* attached SCSI device */
Tejun Heofafbae82007-05-15 03:28:16 +0900447#ifdef CONFIG_ATA_ACPI
448 acpi_handle acpi_handle;
449#endif
Tejun Heo72fa4b72006-05-31 18:27:32 +0900450 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
451 u64 n_sectors; /* size of device, if ATA */
452 unsigned int class; /* ATA_DEV_xxx */
Tejun Heofe635c72006-05-15 20:57:35 +0900453 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 u8 pio_mode;
455 u8 dma_mode;
456 u8 xfer_mode;
457 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
458
Albert Lee8cbd6df2005-10-12 15:06:27 +0800459 unsigned int multi_count; /* sectors count for
460 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900461 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900462 unsigned int cdb_len;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400463
Tejun Heoacf356b2006-03-24 14:07:50 +0900464 /* per-dev xfer mask */
465 unsigned int pio_mask;
466 unsigned int mwdma_mask;
467 unsigned int udma_mask;
468
Albert Lee8bf62ece2005-05-12 15:29:42 -0400469 /* for CHS addressing */
470 u16 cylinders; /* Number of cylinders */
471 u16 heads; /* Number of heads */
472 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900473
474 /* error history */
475 struct ata_ering ering;
Tejun Heo7d47e8d2007-02-02 16:22:31 +0900476 int spdn_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477};
478
Tejun Heo72fa4b72006-05-31 18:27:32 +0900479/* Offset into struct ata_device. Fields above it are maintained
480 * acress device init. Fields below are zeroed.
481 */
482#define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
483
Tejun Heof3e81b12006-05-15 20:58:21 +0900484struct ata_eh_info {
485 struct ata_device *dev; /* offending device */
486 u32 serror; /* SError from LLDD */
487 unsigned int err_mask; /* port-wide err_mask */
488 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900489 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900490 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900491
Tejun Heoabdda732006-05-31 18:27:29 +0900492 unsigned int probe_mask;
493
Tejun Heof3e81b12006-05-15 20:58:21 +0900494 char desc[ATA_EH_DESC_LEN];
495 int desc_len;
496};
497
498struct ata_eh_context {
499 struct ata_eh_info i;
500 int tries[ATA_MAX_DEVICES];
Tejun Heoabdda732006-05-31 18:27:29 +0900501 unsigned int classes[ATA_MAX_DEVICES];
502 unsigned int did_probe_mask;
Tejun Heof3e81b12006-05-15 20:58:21 +0900503};
504
Tejun Heo64578a32007-05-15 03:28:16 +0900505struct ata_acpi_drive
506{
507 u32 pio;
508 u32 dma;
509} __packed;
510
511struct ata_acpi_gtm {
512 struct ata_acpi_drive drive[2];
513 u32 flags;
514} __packed;
515
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900516struct ata_link {
517 struct ata_port *ap;
Tejun Heo89898052007-08-06 18:36:23 +0900518 int pmp; /* port multiplier port # */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900519
520 unsigned int active_tag; /* active tag on this link */
521 u32 sactive; /* active NCQ commands */
522
Tejun Heo0c887582007-08-06 18:36:23 +0900523 unsigned int flags; /* ATA_LFLAG_xxx */
524
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900525 unsigned int hw_sata_spd_limit;
526 unsigned int sata_spd_limit;
527 unsigned int sata_spd; /* current SATA PHY speed */
528
529 /* record runtime error info, protected by host_set lock */
530 struct ata_eh_info eh_info;
531 /* EH context */
532 struct ata_eh_context eh_context;
533
534 struct ata_device device[ATA_MAX_DEVICES];
535};
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400538 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Jeff Garzik057ace52005-10-22 14:27:05 -0400539 const struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400540 spinlock_t *lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 unsigned long flags; /* ATA_FLAG_xxx */
Tejun Heob51e9e52006-06-29 01:29:30 +0900542 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900543 unsigned int print_id; /* user visible unique port ID */
544 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546 struct ata_prd *prd; /* our SG list */
547 dma_addr_t prd_dma; /* and its DMA mapping */
548
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400549 void *pad; /* array of DMA pad buffers */
550 dma_addr_t pad_dma;
551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
553
554 u8 ctl; /* cache of ATA control register */
555 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 unsigned int pio_mask;
557 unsigned int mwdma_mask;
558 unsigned int udma_mask;
559 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
561 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo6cec4a32006-05-15 21:03:41 +0900562 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900563 unsigned int qc_active;
564
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900565 struct ata_link link; /* host default link */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
Tejun Heo89898052007-08-06 18:36:23 +0900567 int nr_pmp_links; /* nr of available PMP links */
568 struct ata_link *pmp_link; /* array of PMP links */
569
Jeff Garzikcca39742006-08-24 03:19:22 -0400570 struct ata_port_stats stats;
571 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600572 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
David Howells65f27f32006-11-22 14:55:48 +0000574 void *port_task_data;
David Howells52bad642006-11-22 14:54:01 +0000575 struct delayed_work port_task;
576 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400577 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900578
Albert Lee14be71f2005-09-27 17:36:35 +0800579 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Randy Dunlapbfd60572006-01-17 19:34:42 -0500581 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900582 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900583 wait_queue_head_t eh_wait_q;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500584
Tejun Heo500530f2006-07-03 16:07:27 +0900585 pm_message_t pm_mesg;
586 int *pm_result;
587
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900588 struct timer_list fastdrain_timer;
589 unsigned long fastdrain_cnt;
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900592
Tejun Heofafbae82007-05-15 03:28:16 +0900593#ifdef CONFIG_ATA_ACPI
594 acpi_handle acpi_handle;
Tejun Heo64578a32007-05-15 03:28:16 +0900595 struct ata_acpi_gtm acpi_gtm;
Tejun Heofafbae82007-05-15 03:28:16 +0900596#endif
Tejun Heofe635c72006-05-15 20:57:35 +0900597 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598};
599
600struct ata_port_operations {
601 void (*port_disable) (struct ata_port *);
602
Alancd0d3bb2007-03-02 00:56:15 +0000603 void (*dev_config) (struct ata_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
605 void (*set_piomode) (struct ata_port *, struct ata_device *);
606 void (*set_dmamode) (struct ata_port *, struct ata_device *);
Alan Coxa76b62c2007-03-09 09:34:07 -0500607 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Jeff Garzik057ace52005-10-22 14:27:05 -0400609 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
611
Jeff Garzik057ace52005-10-22 14:27:05 -0400612 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 u8 (*check_status)(struct ata_port *ap);
614 u8 (*check_altstatus)(struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 void (*dev_select)(struct ata_port *ap, unsigned int device);
616
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900617 void (*phy_reset) (struct ata_port *ap); /* obsolete */
Tejun Heo02607312007-08-06 18:36:23 +0900618 int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900619
Alan Coxbe0d18d2007-03-06 02:37:56 -0800620 int (*cable_detect) (struct ata_port *ap);
621
Alanb229a7b2007-01-24 11:47:07 +0000622 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
624 void (*bmdma_setup) (struct ata_queued_cmd *qc);
625 void (*bmdma_start) (struct ata_queued_cmd *qc);
626
Alan Coxa6b2c5d2006-05-22 16:59:59 +0100627 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 void (*qc_prep) (struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900630 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Tejun Heo9ec957f2006-05-15 20:57:58 +0900632 /* Error handlers. ->error_handler overrides ->eng_timeout and
633 * indicates that new-style EH is in place.
634 */
635 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
636
637 void (*freeze) (struct ata_port *ap);
638 void (*thaw) (struct ata_port *ap);
639 void (*error_handler) (struct ata_port *ap);
640 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
David Howells7d12e782006-10-05 14:55:46 +0100642 irq_handler_t irq_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 void (*irq_clear) (struct ata_port *);
Akira Iguchi83625002007-01-26 16:27:32 +0900644 u8 (*irq_on) (struct ata_port *);
645 u8 (*irq_ack) (struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
Tejun Heoda3dbb12007-07-16 14:29:40 +0900647 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
648 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
Tejun Heo500530f2006-07-03 16:07:27 +0900650 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
651 int (*port_resume) (struct ata_port *ap);
652
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 int (*port_start) (struct ata_port *ap);
654 void (*port_stop) (struct ata_port *ap);
655
Jeff Garzikcca39742006-08-24 03:19:22 -0400656 void (*host_stop) (struct ata_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Alan Coxb73fc892005-08-26 16:03:19 +0100658 void (*bmdma_stop) (struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 u8 (*bmdma_status) (struct ata_port *ap);
660};
661
662struct ata_port_info {
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100663 struct scsi_host_template *sht;
Jeff Garzikcca39742006-08-24 03:19:22 -0400664 unsigned long flags;
Tejun Heo0c887582007-08-06 18:36:23 +0900665 unsigned long link_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 unsigned long pio_mask;
667 unsigned long mwdma_mask;
668 unsigned long udma_mask;
Jeff Garzik057ace52005-10-22 14:27:05 -0400669 const struct ata_port_operations *port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900670 irq_handler_t irq_handler;
Alan Coxe99f8b52005-11-08 14:09:44 +0000671 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672};
673
Alan Cox452503f2005-10-21 19:01:32 -0400674struct ata_timing {
675 unsigned short mode; /* ATA mode */
676 unsigned short setup; /* t1 */
677 unsigned short act8b; /* t2 for 8-bit I/O */
678 unsigned short rec8b; /* t2i for 8-bit I/O */
679 unsigned short cyc8b; /* t0 for 8-bit I/O */
680 unsigned short active; /* t2 or tD */
681 unsigned short recover; /* t2i or tK */
682 unsigned short cycle; /* t0 */
683 unsigned short udma; /* t2CYCTYP/2 */
684};
685
686#define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
Tejun Heoe9c83912006-07-03 16:07:26 +0900688extern const unsigned long sata_deb_timing_normal[];
689extern const unsigned long sata_deb_timing_hotplug[];
690extern const unsigned long sata_deb_timing_long[];
691
Tejun Heodd5b06c2006-08-10 16:59:12 +0900692extern const struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900693extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900694
Tejun Heoe9c83912006-07-03 16:07:26 +0900695static inline const unsigned long *
696sata_ehc_deb_timing(struct ata_eh_context *ehc)
697{
698 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
699 return sata_deb_timing_hotplug;
700 else
701 return sata_deb_timing_normal;
702}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900703
Tejun Heodd5b06c2006-08-10 16:59:12 +0900704static inline int ata_port_is_dummy(struct ata_port *ap)
705{
706 return ap->ops == &ata_dummy_port_ops;
707}
708
Tejun Heo936fd732007-08-06 18:36:23 +0900709extern void sata_print_link_status(struct ata_link *link);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710extern void ata_port_probe(struct ata_port *);
711extern void __sata_phy_reset(struct ata_port *ap);
712extern void sata_phy_reset(struct ata_port *ap);
713extern void ata_bus_reset(struct ata_port *ap);
Tejun Heo936fd732007-08-06 18:36:23 +0900714extern int sata_set_spd(struct ata_link *link);
715extern int sata_link_debounce(struct ata_link *link,
716 const unsigned long *params, unsigned long deadline);
717extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
718 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900719extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
720extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900721 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900722extern int sata_link_hardreset(struct ata_link *link,
723 const unsigned long *timing, unsigned long deadline);
724extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900725 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900726extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727extern void ata_port_disable(struct ata_port *);
728extern void ata_std_ports(struct ata_ioports *ioaddr);
729#ifdef CONFIG_PCI
Tejun Heo1626aeb2007-05-04 12:43:58 +0200730extern int ata_pci_init_one (struct pci_dev *pdev,
731 const struct ata_port_info * const * ppi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732extern void ata_pci_remove_one (struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900733#ifdef CONFIG_PM
Tejun Heo3c5100c2006-07-26 16:58:33 +0900734extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
Tejun Heo553c4aa2006-12-26 19:39:50 +0900735extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
Tejun Heo3c5100c2006-07-26 16:58:33 +0900736extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
Jens Axboe9b847542006-01-06 09:28:07 +0100737extern int ata_pci_device_resume(struct pci_dev *pdev);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900738#endif
Jeff Garzik17bb34a2006-03-21 21:29:21 -0500739extern int ata_pci_clear_simplex(struct pci_dev *pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740#endif /* CONFIG_PCI */
Tejun Heof3187192007-04-17 23:44:07 +0900741extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +0900742extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
743 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heoecef7252007-04-17 23:44:06 +0900744extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +0900745extern int ata_host_register(struct ata_host *host,
746 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +0900747extern int ata_host_activate(struct ata_host *host, int irq,
748 irq_handler_t irq_handler, unsigned long irq_flags,
749 struct scsi_host_template *sht);
Tejun Heo0529c152007-01-20 16:00:26 +0900750extern void ata_host_detach(struct ata_host *host);
Jeff Garzikcca39742006-08-24 03:19:22 -0400751extern void ata_host_init(struct ata_host *, struct device *,
752 unsigned long, const struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -0500753extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
755extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Brian King80289162006-08-07 14:27:31 -0500756extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400757extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500758 struct ata_port_info *, struct Scsi_Host *);
759extern int ata_sas_port_init(struct ata_port *);
760extern int ata_sas_port_start(struct ata_port *ap);
761extern void ata_sas_port_stop(struct ata_port *ap);
762extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
763extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
764 struct ata_port *ap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
Tejun Heo936fd732007-08-06 18:36:23 +0900766extern int sata_scr_valid(struct ata_link *link);
767extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
768extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
769extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
770extern int ata_link_online(struct ata_link *link);
771extern int ata_link_offline(struct ata_link *link);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900772#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -0400773extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
774extern void ata_host_resume(struct ata_host *host);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900775#endif
Jeff Garzik67846b32005-10-05 02:58:32 -0400776extern int ata_ratelimit(void);
Tejun Heod1adc1b2006-10-09 18:32:15 +0900777extern int ata_busy_sleep(struct ata_port *ap,
778 unsigned long timeout_pat, unsigned long timeout);
Tejun Heod4b2bab2007-02-02 16:50:52 +0900779extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
David Howells65f27f32006-11-22 14:55:48 +0000780extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
Tejun Heo86e45b62006-03-05 15:29:09 +0900781 void *data, unsigned long delay);
Tejun Heoc22daff2006-04-11 22:22:29 +0900782extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
783 unsigned long interval_msec,
784 unsigned long timeout_msec);
Akira Iguchia619f981b2007-01-26 16:28:18 +0900785extern unsigned int ata_dev_try_classify(struct ata_port *, unsigned int, u8 *);
Jeff Garzik67846b32005-10-05 02:58:32 -0400786
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787/*
788 * Default driver ops implementations
789 */
Jeff Garzik057ace52005-10-22 14:27:05 -0400790extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
Tejun Heo99771262007-07-16 14:29:38 +0900792extern void ata_tf_to_fis(const struct ata_taskfile *tf,
793 u8 pmp, int is_cmd, u8 *fis);
Jeff Garzik057ace52005-10-22 14:27:05 -0400794extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
796extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
797extern u8 ata_check_status(struct ata_port *ap);
798extern u8 ata_altstatus(struct ata_port *ap);
Jeff Garzik057ace52005-10-22 14:27:05 -0400799extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800extern int ata_port_start (struct ata_port *ap);
Alan Coxd92e74d2007-06-07 16:19:15 +0100801extern int ata_sff_port_start (struct ata_port *ap);
David Howells7d12e782006-10-05 14:55:46 +0100802extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900803extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
804 unsigned int buflen, int write_data);
805extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
806 unsigned int buflen, int write_data);
Alan Coxd26fc952007-07-06 19:13:52 -0400807extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808extern void ata_qc_prep(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -0600809extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Tejun Heo9a3d9eb2006-01-23 13:09:36 +0900810extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
812 unsigned int buflen);
813extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
814 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -0400815extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +0000816extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +0900817extern void ata_id_string(const u16 *id, unsigned char *s,
818 unsigned int ofs, unsigned int len);
819extern void ata_id_c_string(const u16 *id, unsigned char *s,
820 unsigned int ofs, unsigned int len);
Alan10305f02007-02-20 18:01:59 +0000821extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
823extern void ata_bmdma_start (struct ata_queued_cmd *qc);
Alan Coxb73fc892005-08-26 16:03:19 +0100824extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825extern u8 ata_bmdma_status(struct ata_port *ap);
826extern void ata_bmdma_irq_clear(struct ata_port *ap);
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900827extern void ata_bmdma_freeze(struct ata_port *ap);
828extern void ata_bmdma_thaw(struct ata_port *ap);
Tejun Heof5914a42006-05-31 18:27:48 +0900829extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
Tejun Heo6d97dbd2006-05-15 20:58:24 +0900830 ata_reset_fn_t softreset,
831 ata_reset_fn_t hardreset,
832 ata_postreset_fn_t postreset);
833extern void ata_bmdma_error_handler(struct ata_port *ap);
834extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo9a1004d2006-05-31 18:27:52 +0900835extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
836 u8 status, int in_wq);
Tejun Heof686bcb2006-05-15 20:58:05 +0900837extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heodedaf2b2006-05-15 21:03:43 +0900838extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
839 void (*finish_qc)(struct ata_queued_cmd *));
Tejun Heo3373efd2006-05-15 20:57:53 +0900840extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 void (*done)(struct scsi_cmnd *));
842extern int ata_std_bios_param(struct scsi_device *sdev,
843 struct block_device *bdev,
844 sector_t capacity, int geom[]);
845extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +0900846extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900847extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
848 int queue_depth);
Tejun Heo3373efd2006-05-15 20:57:53 +0900849extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Tejun Heo02607312007-08-06 18:36:23 +0900850extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
Akira Iguchi83625002007-01-26 16:27:32 +0900851extern u8 ata_irq_on(struct ata_port *ap);
852extern u8 ata_dummy_irq_on(struct ata_port *ap);
853extern u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq);
854extern u8 ata_dummy_irq_ack(struct ata_port *ap, unsigned int chk_drq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Alan Coxbe0d18d2007-03-06 02:37:56 -0800856extern int ata_cable_40wire(struct ata_port *ap);
857extern int ata_cable_80wire(struct ata_port *ap);
858extern int ata_cable_sata(struct ata_port *ap);
859extern int ata_cable_unknown(struct ata_port *ap);
860
Alan Cox452503f2005-10-21 19:01:32 -0400861/*
862 * Timing helpers
863 */
Alan Cox1bc4ccf2006-01-09 17:18:14 +0000864
865extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Alan Cox452503f2005-10-21 19:01:32 -0400866extern int ata_timing_compute(struct ata_device *, unsigned short,
867 struct ata_timing *, int, int);
868extern void ata_timing_merge(const struct ata_timing *,
869 const struct ata_timing *, struct ata_timing *,
870 unsigned int);
871
872enum {
873 ATA_TIMING_SETUP = (1 << 0),
874 ATA_TIMING_ACT8B = (1 << 1),
875 ATA_TIMING_REC8B = (1 << 2),
876 ATA_TIMING_CYC8B = (1 << 3),
877 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
878 ATA_TIMING_CYC8B,
879 ATA_TIMING_ACTIVE = (1 << 4),
880 ATA_TIMING_RECOVER = (1 << 5),
881 ATA_TIMING_CYCLE = (1 << 6),
882 ATA_TIMING_UDMA = (1 << 7),
883 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
884 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
885 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
886 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
887};
888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
890#ifdef CONFIG_PCI
891struct pci_bits {
892 unsigned int reg; /* PCI config register to read */
893 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
894 unsigned long mask;
895 unsigned long val;
896};
897
Tejun Heod583bc12007-07-04 18:02:07 +0900898extern int ata_pci_init_sff_host(struct ata_host *host);
Tejun Heo1626aeb2007-05-04 12:43:58 +0200899extern int ata_pci_init_bmdma(struct ata_host *host);
Tejun Heod583bc12007-07-04 18:02:07 +0900900extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
901 const struct ata_port_info * const * ppi,
902 struct ata_host **r_host);
Jeff Garzik057ace52005-10-22 14:27:05 -0400903extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
Alan Coxa76b62c2007-03-09 09:34:07 -0500904extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905#endif /* CONFIG_PCI */
906
Tejun Heoece1d632006-04-02 18:51:53 +0900907/*
908 * EH
909 */
Tejun Heoece1d632006-04-02 18:51:53 +0900910extern void ata_eng_timeout(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900911
912extern void ata_port_schedule_eh(struct ata_port *ap);
Tejun Heodbd82612007-08-06 18:36:23 +0900913extern int ata_link_abort(struct ata_link *link);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900914extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +0900915extern int ata_port_freeze(struct ata_port *ap);
916
917extern void ata_eh_freeze_port(struct ata_port *ap);
918extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +0900919
Tejun Heoece1d632006-04-02 18:51:53 +0900920extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
921extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
922
Tejun Heof5914a42006-05-31 18:27:48 +0900923extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
924 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
925 ata_postreset_fn_t postreset);
Tejun Heo022bdb02006-05-15 20:58:22 +0900926
Tejun Heo61440db2006-05-15 20:57:55 +0900927/*
928 * printk helpers
929 */
930#define ata_port_printk(ap, lv, fmt, args...) \
Tejun Heo44877b42007-02-21 01:06:51 +0900931 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Tejun Heo89898052007-08-06 18:36:23 +0900933#define ata_link_printk(link, lv, fmt, args...) do { \
934 if ((link)->ap->nr_pmp_links) \
935 printk(lv"ata%u.%02u: "fmt, (link)->ap->print_id, \
936 (link)->pmp , ##args); \
937 else \
938 printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args); \
939 } while(0)
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900940
Tejun Heo61440db2006-05-15 20:57:55 +0900941#define ata_dev_printk(dev, lv, fmt, args...) \
Tejun Heo89898052007-08-06 18:36:23 +0900942 printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, \
943 (dev)->link->pmp + (dev)->devno , ##args)
Tejun Heo61440db2006-05-15 20:57:55 +0900944
945/*
Tejun Heof3e81b12006-05-15 20:58:21 +0900946 * ata_eh_info helpers
947 */
Tejun Heob64bbc32007-07-16 14:29:39 +0900948extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
949extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
950extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
Tejun Heof3e81b12006-05-15 20:58:21 +0900951
Tejun Heof8f1e1c2007-07-16 14:29:40 +0900952static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
Tejun Heo084fe632006-05-31 18:28:03 +0900953{
Tejun Heof8f1e1c2007-07-16 14:29:40 +0900954 ehi->flags |= ATA_EHI_RESUME_LINK;
Tejun Heo084fe632006-05-31 18:28:03 +0900955 ehi->action |= ATA_EH_SOFTRESET;
956 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
957}
958
Tejun Heoc0b6c032006-07-03 16:07:26 +0900959static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
960{
Tejun Heof8f1e1c2007-07-16 14:29:40 +0900961 ata_ehi_schedule_probe(ehi);
962 ehi->flags |= ATA_EHI_HOTPLUGGED;
Tejun Heoc0b6c032006-07-03 16:07:26 +0900963 ehi->err_mask |= AC_ERR_ATA_BUS;
964}
965
Tejun Heof3e81b12006-05-15 20:58:21 +0900966/*
Tejun Heo61440db2006-05-15 20:57:55 +0900967 * qc helpers
968 */
Jeff Garzik972c26b2005-10-18 22:14:54 -0400969static inline int
970ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
971{
972 if (sg == &qc->pad_sgent)
973 return 1;
974 if (qc->pad_len)
975 return 0;
976 if (((sg - qc->__sg) + 1) == qc->n_elem)
977 return 1;
978 return 0;
979}
980
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400981static inline struct scatterlist *
Tejun Heocc1887f32006-02-20 23:48:38 +0900982ata_qc_first_sg(struct ata_queued_cmd *qc)
983{
984 if (qc->n_elem)
985 return qc->__sg;
986 if (qc->pad_len)
987 return &qc->pad_sgent;
988 return NULL;
989}
990
991static inline struct scatterlist *
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400992ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
993{
994 if (sg == &qc->pad_sgent)
995 return NULL;
996 if (++sg - qc->__sg < qc->n_elem)
997 return sg;
Tejun Heocc1887f32006-02-20 23:48:38 +0900998 if (qc->pad_len)
999 return &qc->pad_sgent;
1000 return NULL;
Jeff Garzikcedc9a42005-10-05 07:13:30 -04001001}
1002
1003#define ata_for_each_sg(sg, qc) \
Tejun Heocc1887f32006-02-20 23:48:38 +09001004 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
Jeff Garzikcedc9a42005-10-05 07:13:30 -04001005
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006static inline unsigned int ata_tag_valid(unsigned int tag)
1007{
1008 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1009}
1010
Tejun Heo2ab7db12006-05-15 20:58:02 +09001011static inline unsigned int ata_tag_internal(unsigned int tag)
1012{
1013 return tag == ATA_MAX_QUEUE - 1;
1014}
1015
Tejun Heo5806db22006-06-24 20:30:19 +09001016/*
1017 * device helpers
1018 */
Tejun Heoe1211e32006-04-01 01:38:18 +09001019static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +09001020{
1021 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
1022}
1023
Tejun Heoe1211e32006-04-01 01:38:18 +09001024static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025{
Tejun Heoe1211e32006-04-01 01:38:18 +09001026 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
1027}
1028
Tejun Heo002c8052006-04-02 17:54:46 +09001029static inline unsigned int ata_class_absent(unsigned int class)
1030{
1031 return !ata_class_enabled(class) && !ata_class_disabled(class);
1032}
1033
Tejun Heoe1211e32006-04-01 01:38:18 +09001034static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1035{
1036 return ata_class_enabled(dev->class);
1037}
1038
1039static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1040{
1041 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042}
1043
Tejun Heo002c8052006-04-02 17:54:46 +09001044static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1045{
1046 return ata_class_absent(dev->class);
1047}
1048
Tejun Heo5806db22006-06-24 20:30:19 +09001049/*
Tejun Heof58229f2007-08-06 18:36:23 +09001050 * link helpers
Tejun Heo5806db22006-06-24 20:30:19 +09001051 */
Tejun Heo89898052007-08-06 18:36:23 +09001052static inline int ata_is_host_link(const struct ata_link *link)
1053{
1054 return link == &link->ap->link;
1055}
1056
Tejun Heof58229f2007-08-06 18:36:23 +09001057static inline int ata_link_max_devices(const struct ata_link *link)
Tejun Heo5806db22006-06-24 20:30:19 +09001058{
Tejun Heo89898052007-08-06 18:36:23 +09001059 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
Tejun Heo5806db22006-06-24 20:30:19 +09001060 return 2;
1061 return 1;
1062}
1063
Tejun Heo89898052007-08-06 18:36:23 +09001064static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1065{
1066 if (ap->nr_pmp_links)
1067 return ap->pmp_link;
1068 return &ap->link;
1069}
1070
1071static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1072{
1073 struct ata_port *ap = link->ap;
1074
1075 if (link == &ap->link) {
1076 if (!ap->nr_pmp_links)
1077 return NULL;
1078 return ap->pmp_link;
1079 }
1080
1081 if (++link - ap->pmp_link < ap->nr_pmp_links)
1082 return link;
1083 return NULL;
1084}
1085
1086#define __ata_port_for_each_link(lk, ap) \
1087 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1088
1089#define ata_port_for_each_link(link, ap) \
1090 for ((link) = ata_port_first_link(ap); (link); \
1091 (link) = ata_port_next_link(link))
Tejun Heof58229f2007-08-06 18:36:23 +09001092
1093#define ata_link_for_each_dev(dev, link) \
1094 for ((dev) = (link)->device; \
1095 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1096 (dev)++)
1097
1098#define ata_link_for_each_dev_reverse(dev, link) \
1099 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1100 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
Tejun Heo5806db22006-06-24 20:30:19 +09001101
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102static inline u8 ata_chk_status(struct ata_port *ap)
1103{
1104 return ap->ops->check_status(ap);
1105}
1106
Tejun Heo6d1245b2007-02-20 23:20:27 +09001107/**
1108 * ata_ncq_enabled - Test whether NCQ is enabled
1109 * @dev: ATA device to test for
1110 *
1111 * LOCKING:
1112 * spin_lock_irqsave(host lock)
1113 *
1114 * RETURNS:
1115 * 1 if NCQ is enabled for @dev, 0 otherwise.
1116 */
1117static inline int ata_ncq_enabled(struct ata_device *dev)
1118{
1119 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1120 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1121}
Edward Falk0baab862005-06-02 18:17:13 -04001122
1123/**
1124 * ata_pause - Flush writes and pause 400 nanoseconds.
1125 * @ap: Port to wait for.
1126 *
1127 * LOCKING:
1128 * Inherited from caller.
1129 */
1130
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131static inline void ata_pause(struct ata_port *ap)
1132{
1133 ata_altstatus(ap);
1134 ndelay(400);
1135}
1136
Edward Falk0baab862005-06-02 18:17:13 -04001137
1138/**
1139 * ata_busy_wait - Wait for a port status register
1140 * @ap: Port to wait for.
Alan07777212007-01-31 17:47:24 +00001141 * @bits: bits that must be clear
1142 * @max: number of 10uS waits to perform
Edward Falk0baab862005-06-02 18:17:13 -04001143 *
1144 * Waits up to max*10 microseconds for the selected bits in the port's
1145 * status register to be cleared.
1146 * Returns final value of status register.
1147 *
1148 * LOCKING:
1149 * Inherited from caller.
1150 */
1151
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1153 unsigned int max)
1154{
1155 u8 status;
1156
1157 do {
1158 udelay(10);
1159 status = ata_chk_status(ap);
1160 max--;
Tejun Heod1adc1b2006-10-09 18:32:15 +09001161 } while (status != 0xff && (status & bits) && (max > 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
1163 return status;
1164}
1165
Edward Falk0baab862005-06-02 18:17:13 -04001166
1167/**
1168 * ata_wait_idle - Wait for a port to be idle.
1169 * @ap: Port to wait for.
1170 *
1171 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1172 * Returns final value of status register.
1173 *
1174 * LOCKING:
1175 * Inherited from caller.
1176 */
1177
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178static inline u8 ata_wait_idle(struct ata_port *ap)
1179{
1180 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1181
Tejun Heo55f39522007-06-25 21:31:05 +09001182 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1183 DPRINTK("ATA: abnormal status 0x%X on port 0x%p\n",
1184 status, ap->ioaddr.status_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185
1186 return status;
1187}
1188
1189static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1190{
1191 qc->tf.ctl |= ATA_NIEN;
1192}
1193
Tejun Heof69499f2006-05-15 20:58:03 +09001194static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1195 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196{
1197 if (likely(ata_tag_valid(tag)))
1198 return &ap->qcmd[tag];
1199 return NULL;
1200}
1201
Tejun Heof69499f2006-05-15 20:58:03 +09001202static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1203 unsigned int tag)
1204{
1205 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1206
1207 if (unlikely(!qc) || !ap->ops->error_handler)
1208 return qc;
1209
1210 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1211 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1212 return qc;
1213
1214 return NULL;
1215}
1216
Tejun Heo3373efd2006-05-15 20:57:53 +09001217static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218{
1219 memset(tf, 0, sizeof(*tf));
1220
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001221 tf->ctl = dev->link->ap->ctl;
Tejun Heo3373efd2006-05-15 20:57:53 +09001222 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 tf->device = ATA_DEVICE_OBS;
1224 else
1225 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1226}
1227
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001228static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1229{
Tejun Heo501e0c502007-01-17 11:34:02 +09001230 qc->dma_dir = DMA_NONE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001231 qc->__sg = NULL;
1232 qc->flags = 0;
Tejun Heo726f0782007-01-03 17:30:39 +09001233 qc->cursg = qc->cursg_ofs = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001234 qc->nbytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001235 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001236 qc->err_mask = 0;
Brian Kingd0f29482007-01-17 12:32:28 -06001237 qc->pad_len = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001238 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001239
Tejun Heo3373efd2006-05-15 20:57:53 +09001240 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001241
1242 /* init result_tf such that it indicates normal completion */
1243 qc->result_tf.command = ATA_DRDY;
1244 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001245}
1246
Jeff Garzik057ace52005-10-22 14:27:05 -04001247static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248{
1249 return ata_id_wcache_enabled(dev->id) ||
1250 ata_id_has_flush(dev->id) ||
1251 ata_id_has_flush_ext(dev->id);
1252}
1253
Jeff Garzika7dac442005-10-30 04:44:42 -05001254static inline unsigned int ac_err_mask(u8 status)
1255{
Albert Lee3655d1d2006-05-19 11:43:04 +08001256 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001257 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001258 if (status & (ATA_ERR | ATA_DF))
1259 return AC_ERR_DEV;
1260 return 0;
1261}
1262
1263static inline unsigned int __ac_err_mask(u8 status)
1264{
1265 unsigned int mask = ac_err_mask(status);
1266 if (mask == 0)
1267 return AC_ERR_OTHER;
1268 return mask;
1269}
1270
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001271static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1272{
1273 ap->pad_dma = 0;
Tejun Heof0d36ef2007-01-20 16:00:28 +09001274 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1275 &ap->pad_dma, GFP_KERNEL);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001276 return (ap->pad == NULL) ? -ENOMEM : 0;
1277}
1278
1279static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1280{
Tejun Heof0d36ef2007-01-20 16:00:28 +09001281 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
Jeff Garzik6037d6b2005-11-04 22:08:00 -05001282}
1283
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001284static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1285{
Tejun Heo49114872007-04-17 23:44:06 +09001286 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001287}
1288
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289#endif /* __LINUX_LIBATA_H__ */