blob: 73112250862c42d78a72b20d241d31a936c34844 [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>
Tejun Heo341c2c92008-05-20 02:17:51 +090030#include <linux/jiffies.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/interrupt.h>
Andrew Morton1c72d8d2005-11-10 16:21:38 -080032#include <linux/dma-mapping.h>
Jens Axboe87260212007-10-16 11:14:12 +020033#include <linux/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>
Tejun Heoceb0c642007-12-05 16:43:06 +090039#include <linux/cdrom.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Jeff Garzika6d967a2006-09-25 15:33:09 -040041/*
42 * Define if arch has non-standard setup. This is a _PCI_ standard
43 * not a legacy or ISA standard.
44 */
45#ifdef CONFIG_ATA_NONSTANDARD
Alan Cox2ec7df02006-08-10 16:59:10 +090046#include <asm/libata-portmap.h>
Jeff Garzika6d967a2006-09-25 15:33:09 -040047#else
48#include <asm-generic/libata-portmap.h>
49#endif
Alan Cox2ec7df02006-08-10 16:59:10 +090050
Linus Torvalds1da177e2005-04-16 15:20:36 -070051/*
Randy Dunlapbfd60572006-01-17 19:34:42 -050052 * compile-time options: to be removed as soon as all the drivers are
53 * converted to the new debugging mechanism
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 */
55#undef ATA_DEBUG /* debugging output */
56#undef ATA_VERBOSE_DEBUG /* yet more debugging output */
57#undef ATA_IRQ_TRAP /* define to ack screaming irqs */
58#undef ATA_NDEBUG /* define to disable quick runtime checks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60
61/* note: prints function name for you */
62#ifdef ATA_DEBUG
Alexander Beregalov1f938d02008-07-21 00:06:19 +040063#define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#ifdef ATA_VERBOSE_DEBUG
Alexander Beregalov1f938d02008-07-21 00:06:19 +040065#define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#else
67#define VPRINTK(fmt, args...)
68#endif /* ATA_VERBOSE_DEBUG */
69#else
70#define DPRINTK(fmt, args...)
71#define VPRINTK(fmt, args...)
72#endif /* ATA_DEBUG */
73
Alexander Beregalov1f938d02008-07-21 00:06:19 +040074#define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
Jeff Garzik2c13b7c2005-11-14 14:14:16 -050075
Randy Dunlapbfd60572006-01-17 19:34:42 -050076/* NEW: debug levels */
77#define HAVE_LIBATA_MSG 1
78
79enum {
80 ATA_MSG_DRV = 0x0001,
81 ATA_MSG_INFO = 0x0002,
82 ATA_MSG_PROBE = 0x0004,
83 ATA_MSG_WARN = 0x0008,
84 ATA_MSG_MALLOC = 0x0010,
85 ATA_MSG_CTL = 0x0020,
86 ATA_MSG_INTR = 0x0040,
87 ATA_MSG_ERR = 0x0080,
88};
89
90#define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
91#define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
92#define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
93#define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
94#define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95#define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
96#define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
97#define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
98
99static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100{
101 if (dval < 0 || dval >= (sizeof(u32) * 8))
102 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
103 if (!dval)
104 return 0;
105 return (1 << dval) - 1;
106}
107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108/* defines only for the constants which don't work well as enums */
109#define ATA_TAG_POISON 0xfafbfcfdU
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111enum {
112 /* various global constants */
113 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
Alan Coxd26fc952007-07-06 19:13:52 -0400114 LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 ATA_DEF_QUEUE = 1,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900116 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
Tejun Heoa6e6ce82006-05-15 21:03:48 +0900117 ATA_MAX_QUEUE = 32,
Tejun Heo2ab7db12006-05-15 20:58:02 +0900118 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
Tejun Heo341c2c92008-05-20 02:17:51 +0900119 ATA_SHORT_PAUSE = 16,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Tejun Heo140b5e52007-12-12 12:21:52 +0900121 ATAPI_MAX_DRAIN = 16 << 10,
122
Tejun Heob558edd2008-01-24 00:05:14 +0900123 ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 ATA_SHT_EMULATED = 1,
126 ATA_SHT_CMD_PER_LUN = 1,
127 ATA_SHT_THIS_ID = -1,
Jeff Garzikcf482932005-10-22 00:19:33 -0400128 ATA_SHT_USE_CLUSTERING = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130 /* struct ata_device stuff */
Tejun Heo949b38a2006-04-02 18:51:52 +0900131 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
132 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
Jeff Garzik029f5462006-04-02 10:30:40 -0400133 ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
Tejun Heo88e49032006-05-15 21:03:38 +0900134 ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
Tejun Heo6fc49ad2006-11-11 20:10:45 +0900135 ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
Tejun Heo67465442007-05-15 03:28:16 +0900136 ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
137 ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
Tejun Heo7d77b242007-09-23 13:14:13 +0900138 ATA_DFLAG_AN = (1 << 7), /* AN configured */
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400139 ATA_DFLAG_HIPM = (1 << 8), /* device supports HIPM */
140 ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */
Tejun Heo91163002008-02-21 13:25:50 +0900141 ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700142 ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
Tejun Heo949b38a2006-04-02 18:51:52 +0900143
Kristen Carlson Accardi25571642007-09-11 11:41:59 -0700144 ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
145 ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
Tejun Heo054a5fb2007-10-25 18:30:36 +0900146 ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
Tejun Heo00115e02007-11-27 19:28:58 +0900147 ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200148 ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
Tejun Heof20ded32007-11-27 19:28:52 +0900149 ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Tejun Heof20ded32007-11-27 19:28:52 +0900151 ATA_DFLAG_DETACH = (1 << 24),
152 ATA_DFLAG_DETACHED = (1 << 25),
Tejun Heoabdda732006-05-31 18:27:29 +0900153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 ATA_DEV_UNKNOWN = 0, /* unknown device */
155 ATA_DEV_ATA = 1, /* ATA device */
156 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
157 ATA_DEV_ATAPI = 3, /* ATAPI device */
158 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
Tejun Heoe0a71752007-09-23 13:14:12 +0900159 ATA_DEV_PMP = 5, /* SATA port multiplier */
160 ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
161 ATA_DEV_SEMB = 7, /* SEMB */
162 ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
163 ATA_DEV_NONE = 9, /* no device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Tejun Heo0c887582007-08-06 18:36:23 +0900165 /* struct ata_link flags */
Tejun Heo05944bd2008-08-13 20:19:09 +0900166 ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
Tejun Heoae791c02007-09-23 13:14:12 +0900167 ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
168 ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
169 ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
170 ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
Tejun Heofd995f72007-09-23 13:14:12 +0900171 ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
Tejun Heof9df58c2007-09-23 13:14:13 +0900172 ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700173 ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
Tejun Heo0c887582007-08-06 18:36:23 +0900174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 /* struct ata_port flags */
Tejun Heo949b38a2006-04-02 18:51:52 +0900176 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 /* (doesn't imply presence) */
Tejun Heo949b38a2006-04-02 18:51:52 +0900178 ATA_FLAG_SATA = (1 << 1),
179 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
180 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
181 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
182 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
183 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
184 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
185 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
Tejun Heo7395acb2006-05-31 18:27:25 +0900186 ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
187 * doesn't handle PIO interrupts */
188 ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
Rafael J. Wysocki2a6e58d2009-01-19 20:56:43 +0100189 ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
190 ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
Tejun Heo7395acb2006-05-31 18:27:25 +0900191 ATA_FLAG_DEBUGMSG = (1 << 13),
Shaohua Li388539f2009-07-27 09:24:35 +0800192 ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
Tejun Heob2a8bbe2007-01-25 19:40:05 +0900193 ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
Alan Coxf834e492007-02-07 13:46:00 -0800194 ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
Tejun Heo3cadbcc2007-05-15 03:28:15 +0900195 ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
Kristen Carlson Accardi9f45cbd2007-08-15 03:57:11 -0400196 ATA_FLAG_AN = (1 << 18), /* controller supports AN */
Tejun Heoe0a71752007-09-23 13:14:12 +0900197 ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400198 ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700199 ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
200 * management */
201 ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
202 * led */
Jens Axboe9b847542006-01-06 09:28:07 +0100203
Tejun Heob51e9e52006-06-29 01:29:30 +0900204 /* The following flag belongs to ap->pflags but is kept in
205 * ap->flags because it's referenced in many LLDs and will be
206 * removed in not-too-distant future.
207 */
208 ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
Tejun Heo9ec957f2006-05-15 20:57:58 +0900209
Tejun Heob51e9e52006-06-29 01:29:30 +0900210 /* bits 24:31 of ap->flags are reserved for LLD specific flags */
Alan Cox8d238e02006-01-17 20:50:31 +0000211
Alan Coxe3cf95d2009-04-09 17:31:17 +0100212
Tejun Heob51e9e52006-06-29 01:29:30 +0900213 /* struct ata_port pflags */
214 ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
215 ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
216 ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
217 ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
218 ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
Tejun Heob51e9e52006-06-29 01:29:30 +0900219 ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
Tejun Heof4d6d002007-05-01 11:50:15 +0200220 ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
Tejun Heoafaa5c32007-10-09 15:06:10 +0900221 ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
Tejun Heoece180d2008-11-03 20:04:37 +0900222 ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
223 ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
Tejun Heob51e9e52006-06-29 01:29:30 +0900224
Tejun Heob51e9e52006-06-29 01:29:30 +0900225 ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
Tejun Heo500530f2006-07-03 16:07:27 +0900226 ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900227 ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
Tejun Heodde44582006-02-02 00:56:10 +0900228
Alan Coxe3cf95d2009-04-09 17:31:17 +0100229 ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
230 ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
231
Tejun Heo949b38a2006-04-02 18:51:52 +0900232 /* struct ata_queued_cmd flags */
233 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
Tejun Heo001102d2007-12-05 16:43:09 +0900234 ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
Tejun Heo27197362006-04-02 18:51:53 +0900235 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
Tejun Heoe61e0672006-05-15 20:57:40 +0900236 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
Tejun Heoda917d62007-09-23 13:14:12 +0900237 ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
Tejun Heoe027bd32007-10-26 16:19:26 +0900238 ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
Tejun Heo03faab72008-03-27 19:14:24 +0900239 ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
Tejun Heoe61e0672006-05-15 20:57:40 +0900240
Tejun Heo9ec957f2006-05-15 20:57:58 +0900241 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
242 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
243 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Alan Cox4e5ec5d2006-03-27 18:42:40 +0100245 /* host set flags */
Jeff Garzikcca39742006-08-24 03:19:22 -0400246 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
Tejun Heoecef7252007-04-17 23:44:06 +0900247 ATA_HOST_STARTED = (1 << 1), /* Host started */
Arjan van de Ven886ad092009-01-09 15:54:07 -0800248 ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
Jeff Garzik9bec2e32006-08-31 00:02:15 -0400249
Tejun Heob8b275e2007-07-10 15:55:43 +0900250 /* bits 24:31 of host->flags are reserved for LLD specific flags */
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 /* various lengths of time */
Tejun Heo341c2c92008-05-20 02:17:51 +0900253 ATA_TMOUT_BOOT = 30000, /* heuristic */
254 ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
Tejun Heo341c2c92008-05-20 02:17:51 +0900255 ATA_TMOUT_INTERNAL_QUICK = 5000,
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200256 ATA_TMOUT_MAX_PARK = 30000,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700258 /* FIXME: GoVault needs 2s but we can't afford that without
259 * parallel probing. 800ms is enough for iVDR disk
260 * HHD424020F7SV00. Increase to 2secs when parallel probing
261 * is in place.
262 */
Tejun Heo341c2c92008-05-20 02:17:51 +0900263 ATA_TMOUT_FF_WAIT = 800,
Tejun Heo88ff6ea2007-10-16 14:21:24 -0700264
Tejun Heo705e76b2008-04-07 22:47:19 +0900265 /* Spec mandates to wait for ">= 2ms" before checking status
266 * after reset. We wait 150ms, because that was the magic
267 * delay used for ATAPI devices in Hale Landis's ATADRVR, for
268 * the period of time between when the ATA command register is
269 * written, and then status is checked. Because waiting for
270 * "a while" before checking status is fine, post SRST, we
271 * perform this magic delay here as well.
272 *
273 * Old drivers/ide uses the 2mS rule and then waits for ready.
274 */
Tejun Heo341c2c92008-05-20 02:17:51 +0900275 ATA_WAIT_AFTER_RESET = 150,
Tejun Heo705e76b2008-04-07 22:47:19 +0900276
Tejun Heo9dadd452008-04-07 22:47:19 +0900277 /* If PMP is supported, we have to do follow-up SRST. As some
278 * PMPs don't send D2H Reg FIS after hardreset, LLDs are
279 * advised to wait only for the following duration before
280 * doing SRST.
281 */
Stuart Hayese7d3ef12009-03-04 11:59:46 -0800282 ATA_TMOUT_PMP_SRST_WAIT = 5000,
Tejun Heo9dadd452008-04-07 22:47:19 +0900283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 /* ATA bus states */
285 BUS_UNKNOWN = 0,
286 BUS_DMA = 1,
287 BUS_IDLE = 2,
288 BUS_NOINTR = 3,
289 BUS_NODATA = 4,
290 BUS_TIMER = 5,
291 BUS_PIO = 6,
292 BUS_EDD = 7,
293 BUS_IDENTIFY = 8,
294 BUS_PACKET = 9,
295
296 /* SATA port states */
297 PORT_UNKNOWN = 0,
298 PORT_ENABLED = 1,
299 PORT_DISABLED = 2,
300
301 /* encoding various smaller bitmaps into a single
Tejun Heo7dc951a2007-11-27 19:43:42 +0900302 * unsigned long bitmap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 */
Tejun Heo70cd0712007-11-27 19:43:40 +0900304 ATA_NR_PIO_MODES = 7,
305 ATA_NR_MWDMA_MODES = 5,
306 ATA_NR_UDMA_MODES = 8,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900307
308 ATA_SHIFT_PIO = 0,
Tejun Heo70cd0712007-11-27 19:43:40 +0900309 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
310 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
Tejun Heo1da7b0d2006-03-06 04:31:56 +0900311
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400312 /* size of buffer to pad xfers ending on unaligned boundaries */
313 ATA_DMA_PAD_SZ = 4,
Tejun Heo949b38a2006-04-02 18:51:52 +0900314
Tejun Heo0c247c52006-05-15 20:58:19 +0900315 /* ering size */
316 ATA_ERING_SIZE = 32,
317
Tejun Heo31cc23b2007-09-23 13:14:12 +0900318 /* return values for ->qc_defer */
319 ATA_DEFER_LINK = 1,
320 ATA_DEFER_PORT = 2,
321
Tejun Heof3e81b12006-05-15 20:58:21 +0900322 /* desc_len for ata_eh_info and context */
323 ATA_EH_DESC_LEN = 80,
324
Tejun Heo9be1e972006-05-15 20:58:17 +0900325 /* reset / recovery action types */
326 ATA_EH_REVALIDATE = (1 << 0),
Tejun Heocf480622008-01-24 00:05:14 +0900327 ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
328 ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
329 ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
Tejun Heof9df58c2007-09-23 13:14:13 +0900330 ATA_EH_ENABLE_LINK = (1 << 3),
Tejun Heo3ec25eb2008-03-27 18:37:14 +0900331 ATA_EH_LPM = (1 << 4), /* link power management action */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200332 ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
Tejun Heo9be1e972006-05-15 20:58:17 +0900333
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200334 ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
Tejun Heob5b3fa32008-07-31 17:02:42 +0900335 ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
336 ATA_EH_ENABLE_LINK | ATA_EH_LPM,
Tejun Heo9be1e972006-05-15 20:58:17 +0900337
Tejun Heof3e81b12006-05-15 20:58:21 +0900338 /* ata_eh_info->flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900339 ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
Tejun Heo1cdaf532006-07-03 16:07:26 +0900340 ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
341 ATA_EHI_QUIET = (1 << 3), /* be quiet */
Tejun Heoabdda732006-05-31 18:27:29 +0900342
Tejun Heo0d64a232007-04-23 02:41:05 +0900343 ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
344 ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
345 ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
346 ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
347 ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
Tejun Heof3e81b12006-05-15 20:58:21 +0900348
Tejun Heo0d64a232007-04-23 02:41:05 +0900349 ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
Tejun Heo13abf502006-07-10 23:18:46 +0900350
Tejun Heo848e4c62008-10-21 14:26:39 +0900351 /* mask of flags to transfer *to* the slave link */
352 ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
353
Tejun Heoa1e10f72007-08-18 13:28:49 +0900354 /* max tries if error condition is still set after ->error_handler */
355 ATA_EH_MAX_TRIES = 5,
Tejun Heoad9e2762006-05-15 20:58:12 +0900356
Tejun Heo5040ab62010-01-11 11:14:44 +0900357 /* sometimes resuming a link requires several retries */
358 ATA_LINK_RESUME_TRIES = 5,
359
Tejun Heo14d2bac2006-04-02 17:54:46 +0900360 /* how hard are we gonna try to probe/recover devices */
361 ATA_PROBE_MAX_TRIES = 3,
Tejun Heo022bdb02006-05-15 20:58:22 +0900362 ATA_EH_DEV_TRIES = 3,
Tejun Heoe0a71752007-09-23 13:14:12 +0900363 ATA_EH_PMP_TRIES = 5,
364 ATA_EH_PMP_LINK_TRIES = 3,
365
Tejun Heobf1bff62008-05-19 01:15:10 +0900366 SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
Tejun Heof5914a42006-05-31 18:27:48 +0900367
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900368 /* This should match the actual table size of
369 * ata_eh_cmd_timeout_table in libata-eh.c.
370 */
Tejun Heo6013efd2009-11-19 15:36:45 +0900371 ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900372
Alan Cox93590852006-09-12 16:55:12 +0100373 /* Horkage types. May be set by libata or controller on drives
374 (some horkage may be drive/controller pair dependant */
375
376 ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
Alan Cox6919a0a2006-10-27 19:08:46 -0700377 ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
378 ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
Albert Lee18d6e9d2007-04-02 11:34:15 +0800379 ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
Tejun Heo16c55b02007-08-29 11:58:33 +0900380 ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
Tejun Heo50af2fa2008-05-19 01:15:14 +0900381 ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
Alan Cox93328e12007-09-29 04:06:48 -0400382 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400383 ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
Alan Cox6bbfd532007-11-05 22:58:58 +0000384 ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
Albert Lee2d3b8ee2007-11-15 10:35:46 +0900385 ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
Jens Axboe9ce8e302008-08-27 15:23:18 +0200386 ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
Tejun Heo6a87e422008-11-03 19:01:09 +0900387 ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
388 not multiple of 16 bytes */
Nick Andrew877d0312009-01-26 11:06:57 +0100389 ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
Tejun Heo90627122009-01-29 20:31:36 +0900390 ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
Tejun Heod0cb43b2009-07-09 09:27:50 +0900391 ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
Shaohua Li388539f2009-07-27 09:24:35 +0800392 ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
Alan Coxb3a70602007-10-02 12:38:26 -0400393
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400394 /* DMA mask for user DMA control: User visible values; DO NOT
Alan Coxb3a70602007-10-02 12:38:26 -0400395 renumber */
396 ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
397 ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
398 ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
Tejun Heoceb0c642007-12-05 16:43:06 +0900399
400 /* ATAPI command types */
401 ATAPI_READ = 0, /* READs */
402 ATAPI_WRITE = 1, /* WRITEs */
403 ATAPI_READ_CD = 2, /* READ CD [MSF] */
Tejun Heoe52dcc42008-04-02 17:35:19 +0900404 ATAPI_PASS_THRU = 3, /* SAT pass-thru */
405 ATAPI_MISC = 4, /* the rest */
Tejun Heo624d5c52008-03-25 22:16:41 +0900406
407 /* Timing constants */
408 ATA_TIMING_SETUP = (1 << 0),
409 ATA_TIMING_ACT8B = (1 << 1),
410 ATA_TIMING_REC8B = (1 << 2),
411 ATA_TIMING_CYC8B = (1 << 3),
412 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
413 ATA_TIMING_CYC8B,
414 ATA_TIMING_ACTIVE = (1 << 4),
415 ATA_TIMING_RECOVER = (1 << 5),
David Daney3ada9c12009-01-15 17:45:31 -0800416 ATA_TIMING_DMACK_HOLD = (1 << 6),
417 ATA_TIMING_CYCLE = (1 << 7),
418 ATA_TIMING_UDMA = (1 << 8),
Tejun Heo624d5c52008-03-25 22:16:41 +0900419 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
420 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
421 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
David Daney3ada9c12009-01-15 17:45:31 -0800422 ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
423 ATA_TIMING_UDMA,
Tejun Heof1bce7f2009-09-16 04:16:04 +0900424
425 /* ACPI constants */
426 ATA_ACPI_FILTER_SETXFER = 1 << 0,
427 ATA_ACPI_FILTER_LOCK = 1 << 1,
428 ATA_ACPI_FILTER_DIPM = 1 << 2,
Tejun Heofa5b5612009-09-16 04:17:02 +0900429 ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
430 ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
Tejun Heof1bce7f2009-09-16 04:16:04 +0900431
432 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
433 ATA_ACPI_FILTER_LOCK |
434 ATA_ACPI_FILTER_DIPM,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435};
436
Tejun Heo7dc951a2007-11-27 19:43:42 +0900437enum ata_xfer_mask {
438 ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
439 << ATA_SHIFT_PIO,
440 ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
441 << ATA_SHIFT_MWDMA,
442 ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
443 << ATA_SHIFT_UDMA,
444};
445
Albert Lee14be71f2005-09-27 17:36:35 +0800446enum hsm_task_states {
Albert Leec56b14d2005-09-30 19:07:39 +0800447 HSM_ST_IDLE, /* no command on going */
Albert Lee71527642007-04-02 11:28:52 +0800448 HSM_ST_FIRST, /* (waiting the device to)
449 write CDB or first data block */
Albert Leec56b14d2005-09-30 19:07:39 +0800450 HSM_ST, /* (waiting the device to) transfer data */
451 HSM_ST_LAST, /* (waiting the device to) complete command */
Albert Leec56b14d2005-09-30 19:07:39 +0800452 HSM_ST_ERR, /* error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453};
454
Jeff Garzika7dac442005-10-30 04:44:42 -0500455enum ata_completion_errors {
Tejun Heo11a56d22006-01-23 13:09:36 +0900456 AC_ERR_DEV = (1 << 0), /* device reported error */
457 AC_ERR_HSM = (1 << 1), /* host state machine violation */
458 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
459 AC_ERR_MEDIA = (1 << 3), /* media error */
460 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
461 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
462 AC_ERR_SYSTEM = (1 << 6), /* system error */
463 AC_ERR_INVALID = (1 << 7), /* invalid argument */
464 AC_ERR_OTHER = (1 << 8), /* unknown */
Tejun Heo55a8e2c2006-11-10 18:08:10 +0900465 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
Tejun Heo5335b722007-07-16 14:29:40 +0900466 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
Jeff Garzika7dac442005-10-30 04:44:42 -0500467};
468
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469/* forward declarations */
470struct scsi_device;
471struct ata_port_operations;
472struct ata_port;
Tejun Heocc0680a2007-08-06 18:36:23 +0900473struct ata_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474struct ata_queued_cmd;
475
476/* typedefs */
Tejun Heo77853bf2006-01-23 13:09:36 +0900477typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
Tejun Heocc0680a2007-08-06 18:36:23 +0900478typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
479typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
Tejun Heod4b2bab2007-02-02 16:50:52 +0900480 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900481typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400483/*
484 * host pm policy: If you alter this, you also need to alter libata-scsi.c
485 * (for the ascii descriptions)
486 */
487enum link_pm {
488 NOT_AVAILABLE,
489 MIN_POWER,
490 MAX_PERFORMANCE,
491 MEDIUM_POWER,
492};
Tony Jonesee959b02008-02-22 00:13:36 +0100493extern struct device_attribute dev_attr_link_power_management_policy;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200494extern struct device_attribute dev_attr_unload_heads;
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700495extern struct device_attribute dev_attr_em_message_type;
496extern struct device_attribute dev_attr_em_message;
497extern struct device_attribute dev_attr_sw_activity;
498
499enum sw_activity {
500 OFF,
501 BLINK_ON,
502 BLINK_OFF,
503};
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400504
Tejun Heo127102a2008-04-07 22:47:21 +0900505#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506struct ata_ioports {
Tejun Heo0d5ff562007-02-01 15:06:36 +0900507 void __iomem *cmd_addr;
508 void __iomem *data_addr;
509 void __iomem *error_addr;
510 void __iomem *feature_addr;
511 void __iomem *nsect_addr;
512 void __iomem *lbal_addr;
513 void __iomem *lbam_addr;
514 void __iomem *lbah_addr;
515 void __iomem *device_addr;
516 void __iomem *status_addr;
517 void __iomem *command_addr;
518 void __iomem *altstatus_addr;
519 void __iomem *ctl_addr;
520 void __iomem *bmdma_addr;
521 void __iomem *scr_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522};
Tejun Heo127102a2008-04-07 22:47:21 +0900523#endif /* CONFIG_ATA_SFF */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Jeff Garzikcca39742006-08-24 03:19:22 -0400525struct ata_host {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 spinlock_t lock;
527 struct device *dev;
Tejun Heo0d5ff562007-02-01 15:06:36 +0900528 void __iomem * const *iomap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 unsigned int n_ports;
530 void *private_data;
Tejun Heo029cfd62008-03-25 12:22:49 +0900531 struct ata_port_operations *ops;
Alan Cox5444a6f2006-03-27 18:58:20 +0100532 unsigned long flags;
Tejun Heofafbae82007-05-15 03:28:16 +0900533#ifdef CONFIG_ATA_ACPI
534 acpi_handle acpi_handle;
535#endif
Alan032af1c2007-03-01 17:36:46 +0000536 struct ata_port *simplex_claimed; /* channel owning the DMA */
Tejun Heof0eb62b2006-06-12 23:05:38 +0900537 struct ata_port *ports[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538};
539
540struct ata_queued_cmd {
541 struct ata_port *ap;
542 struct ata_device *dev;
543
544 struct scsi_cmnd *scsicmd;
545 void (*scsidone)(struct scsi_cmnd *);
546
547 struct ata_taskfile tf;
548 u8 cdb[ATAPI_CDB_LEN];
549
550 unsigned long flags; /* ATA_QCFLAG_xxx */
551 unsigned int tag;
552 unsigned int n_elem;
FUJITA Tomonori58256272009-02-27 17:35:43 +0900553 unsigned int orig_n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
555 int dma_dir;
556
Mark Lord5a5dbd12007-03-16 10:22:26 -0400557 unsigned int sect_size;
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 unsigned int nbytes;
Tejun Heoaacda372008-03-18 17:47:43 +0900560 unsigned int extrabytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 unsigned int curbytes;
562
Jens Axboe87260212007-10-16 11:14:12 +0200563 struct scatterlist *cursg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 unsigned int cursg_ofs;
565
566 struct scatterlist sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Tejun Heoff2aeb12007-12-05 16:43:11 +0900568 struct scatterlist *sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
Albert Leea22e2eb2005-12-05 15:38:02 +0800570 unsigned int err_mask;
Tejun Heoe61e0672006-05-15 20:57:40 +0900571 struct ata_taskfile result_tf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 ata_qc_cb_t complete_fn;
573
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 void *private_data;
Darrick J. Wong1c50dc82007-01-30 01:18:41 -0800575 void *lldd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576};
577
Jeff Garzikcca39742006-08-24 03:19:22 -0400578struct ata_port_stats {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 unsigned long unhandled_irq;
580 unsigned long idle_irq;
581 unsigned long rw_reqbuf;
582};
583
Tejun Heo0c247c52006-05-15 20:58:19 +0900584struct ata_ering_entry {
Tejun Heo3884f7b2007-11-27 19:28:56 +0900585 unsigned int eflags;
Tejun Heo0c247c52006-05-15 20:58:19 +0900586 unsigned int err_mask;
587 u64 timestamp;
588};
589
590struct ata_ering {
591 int cursor;
592 struct ata_ering_entry ring[ATA_ERING_SIZE];
593};
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595struct ata_device {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900596 struct ata_link *link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 unsigned int devno; /* 0 or 1 */
Tejun Heo75683fe2007-07-05 13:31:27 +0900598 unsigned int horkage; /* List of broken features */
Richard Kennedy6866e7b2008-09-22 14:47:13 -0700599 unsigned long flags; /* ATA_DFLAG_xxx */
Tejun Heo3edebac2006-05-31 18:27:40 +0900600 struct scsi_device *sdev; /* attached SCSI device */
Bartlomiej Zolnierkiewicz95514fd2009-11-25 18:12:48 +0100601 void *private_data;
Tejun Heofafbae82007-05-15 03:28:16 +0900602#ifdef CONFIG_ATA_ACPI
603 acpi_handle acpi_handle;
Tejun Heo398e0782007-12-15 15:05:03 +0900604 union acpi_object *gtf_cache;
Tejun Heo110f66d2009-09-16 04:17:28 +0900605 unsigned int gtf_filter;
Tejun Heofafbae82007-05-15 03:28:16 +0900606#endif
Tejun Heo99cf6102009-01-29 20:31:32 +0900607 /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900608 u64 n_sectors; /* size of device, if ATA */
Tejun Heo5920dad2009-07-15 17:11:41 +0900609 u64 n_native_sectors; /* native size, if ATA */
Tejun Heo72fa4b72006-05-31 18:27:32 +0900610 unsigned int class; /* ATA_DEV_xxx */
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200611 unsigned long unpark_deadline;
Tejun Heoe0a71752007-09-23 13:14:12 +0900612
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 u8 pio_mode;
614 u8 dma_mode;
615 u8 xfer_mode;
616 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
617
Albert Lee8cbd6df2005-10-12 15:06:27 +0800618 unsigned int multi_count; /* sectors count for
619 READ/WRITE MULTIPLE */
Tejun Heob00eec12006-02-12 23:32:59 +0900620 unsigned int max_sectors; /* per-device max sectors */
Tejun Heo6e7846e2006-02-12 23:32:58 +0900621 unsigned int cdb_len;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400622
Tejun Heoacf356b2006-03-24 14:07:50 +0900623 /* per-dev xfer mask */
Tejun Heo7dc951a2007-11-27 19:43:42 +0900624 unsigned long pio_mask;
625 unsigned long mwdma_mask;
626 unsigned long udma_mask;
Tejun Heoacf356b2006-03-24 14:07:50 +0900627
Albert Lee8bf62ec2005-05-12 15:29:42 -0400628 /* for CHS addressing */
629 u16 cylinders; /* Number of cylinders */
630 u16 heads; /* Number of heads */
631 u16 sectors; /* Number of sectors per track */
Tejun Heo0c247c52006-05-15 20:58:19 +0900632
Jeff Garzikf7e98932008-04-29 17:47:34 -0400633 union {
634 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
635 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
636 };
Tejun Heo99cf6102009-01-29 20:31:32 +0900637
638 /* error history */
639 int spdn_cnt;
640 /* ering is CLEAR_END, read comment above CLEAR_END */
641 struct ata_ering ering;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642};
643
Tejun Heo99cf6102009-01-29 20:31:32 +0900644/* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
645 * cleared to zero on ata_dev_init().
Tejun Heo72fa4b72006-05-31 18:27:32 +0900646 */
Tejun Heo99cf6102009-01-29 20:31:32 +0900647#define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
648#define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
Tejun Heo72fa4b72006-05-31 18:27:32 +0900649
Tejun Heof3e81b12006-05-15 20:58:21 +0900650struct ata_eh_info {
651 struct ata_device *dev; /* offending device */
652 u32 serror; /* SError from LLDD */
653 unsigned int err_mask; /* port-wide err_mask */
654 unsigned int action; /* ATA_EH_* action mask */
Tejun Heo47005f22006-06-19 18:27:23 +0900655 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
Tejun Heof3e81b12006-05-15 20:58:21 +0900656 unsigned int flags; /* ATA_EHI_* flags */
Tejun Heoabdda732006-05-31 18:27:29 +0900657
Tejun Heoabdda732006-05-31 18:27:29 +0900658 unsigned int probe_mask;
659
Tejun Heof3e81b12006-05-15 20:58:21 +0900660 char desc[ATA_EH_DESC_LEN];
661 int desc_len;
662};
663
664struct ata_eh_context {
665 struct ata_eh_info i;
666 int tries[ATA_MAX_DEVICES];
Tejun Heo87fbc5a2008-05-20 02:17:54 +0900667 int cmd_timeout_idx[ATA_MAX_DEVICES]
668 [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
Tejun Heoabdda732006-05-31 18:27:29 +0900669 unsigned int classes[ATA_MAX_DEVICES];
670 unsigned int did_probe_mask;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200671 unsigned int unloaded_mask;
Tejun Heo00115e02007-11-27 19:28:58 +0900672 unsigned int saved_ncq_enabled;
673 u8 saved_xfer_mode[ATA_MAX_DEVICES];
Tejun Heo0a2c0f52008-05-20 02:17:52 +0900674 /* timestamp for the last reset attempt or success */
675 unsigned long last_reset;
Tejun Heof3e81b12006-05-15 20:58:21 +0900676};
677
Tejun Heo64578a32007-05-15 03:28:16 +0900678struct ata_acpi_drive
679{
680 u32 pio;
681 u32 dma;
682} __packed;
683
684struct ata_acpi_gtm {
685 struct ata_acpi_drive drive[2];
686 u32 flags;
687} __packed;
688
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900689struct ata_link {
690 struct ata_port *ap;
Tejun Heo89898052007-08-06 18:36:23 +0900691 int pmp; /* port multiplier port # */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900692
693 unsigned int active_tag; /* active tag on this link */
694 u32 sactive; /* active NCQ commands */
695
Tejun Heo0c887582007-08-06 18:36:23 +0900696 unsigned int flags; /* ATA_LFLAG_xxx */
697
Tejun Heod127ea72008-07-31 16:09:34 +0900698 u32 saved_scontrol; /* SControl on probe */
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900699 unsigned int hw_sata_spd_limit;
700 unsigned int sata_spd_limit;
701 unsigned int sata_spd; /* current SATA PHY speed */
702
703 /* record runtime error info, protected by host_set lock */
704 struct ata_eh_info eh_info;
705 /* EH context */
706 struct ata_eh_context eh_context;
707
708 struct ata_device device[ATA_MAX_DEVICES];
709};
710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711struct ata_port {
Jeff Garzikcca39742006-08-24 03:19:22 -0400712 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
Tejun Heo029cfd62008-03-25 12:22:49 +0900713 struct ata_port_operations *ops;
Jeff Garzikba6a1302006-06-22 23:46:10 -0400714 spinlock_t *lock;
Alan Coxe3cf95d2009-04-09 17:31:17 +0100715 /* Flags owned by the EH context. Only EH should touch these once the
716 port is active */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 unsigned long flags; /* ATA_FLAG_xxx */
Alan Coxe3cf95d2009-04-09 17:31:17 +0100718 /* Flags that change dynamically, protected by ap->lock */
Tejun Heob51e9e52006-06-29 01:29:30 +0900719 unsigned int pflags; /* ATA_PFLAG_xxx */
Tejun Heo44877b42007-02-21 01:06:51 +0900720 unsigned int print_id; /* user visible unique port ID */
721 unsigned int port_no; /* 0 based port no. inside the host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
723 struct ata_prd *prd; /* our SG list */
724 dma_addr_t prd_dma; /* and its DMA mapping */
725
Tejun Heo127102a2008-04-07 22:47:21 +0900726#ifdef CONFIG_ATA_SFF
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
Tejun Heo127102a2008-04-07 22:47:21 +0900728#endif /* CONFIG_ATA_SFF */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 u8 ctl; /* cache of ATA control register */
731 u8 last_ctl; /* Cache last written value */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 unsigned int pio_mask;
733 unsigned int mwdma_mask;
734 unsigned int udma_mask;
735 unsigned int cbl; /* cable type; ATA_CBL_xxx */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
737 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
Tejun Heo8a8bc222008-11-10 14:48:21 +0900738 unsigned long qc_allocated;
Tejun Heodedaf2b2006-05-15 21:03:43 +0900739 unsigned int qc_active;
Tejun Heoda917d62007-09-23 13:14:12 +0900740 int nr_active_links; /* #links with active qcs */
Tejun Heodedaf2b2006-05-15 21:03:43 +0900741
Tejun Heob1c72912008-07-31 17:02:43 +0900742 struct ata_link link; /* host default link */
743 struct ata_link *slave_link; /* see ata_slave_link_init() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Tejun Heo89898052007-08-06 18:36:23 +0900745 int nr_pmp_links; /* nr of available PMP links */
746 struct ata_link *pmp_link; /* array of PMP links */
Tejun Heoda917d62007-09-23 13:14:12 +0900747 struct ata_link *excl_link; /* for PMP qc exclusion */
Tejun Heo89898052007-08-06 18:36:23 +0900748
Jeff Garzikcca39742006-08-24 03:19:22 -0400749 struct ata_port_stats stats;
750 struct ata_host *host;
Brian King2f1f6102006-03-23 17:30:15 -0600751 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
David Howells65f27f32006-11-22 14:55:48 +0000753 void *port_task_data;
David Howells52bad642006-11-22 14:54:01 +0000754 struct delayed_work port_task;
755 struct delayed_work hotplug_task;
Jeff Garzik3b01b8a2006-06-12 00:22:04 -0400756 struct work_struct scsi_rescan_task;
Tejun Heo86e45b62006-03-05 15:29:09 +0900757
Albert Lee14be71f2005-09-27 17:36:35 +0800758 unsigned int hsm_task_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
Randy Dunlapbfd60572006-01-17 19:34:42 -0500760 u32 msg_enable;
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900761 struct list_head eh_done_q;
Tejun Heoc6cf9e92006-05-31 18:27:27 +0900762 wait_queue_head_t eh_wait_q;
Tejun Heoa1e10f72007-08-18 13:28:49 +0900763 int eh_tries;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +0200764 struct completion park_req_pending;
Randy Dunlapbfd60572006-01-17 19:34:42 -0500765
Tejun Heo500530f2006-07-03 16:07:27 +0900766 pm_message_t pm_mesg;
767 int *pm_result;
Kristen Carlson Accardica773292007-10-25 00:58:59 -0400768 enum link_pm pm_policy;
Tejun Heo500530f2006-07-03 16:07:27 +0900769
Tejun Heo5ddf24c2007-07-16 14:29:41 +0900770 struct timer_list fastdrain_timer;
771 unsigned long fastdrain_cnt;
772
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700773 int em_message_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 void *private_data;
Tejun Heofe635c72006-05-15 20:57:35 +0900775
Tejun Heofafbae82007-05-15 03:28:16 +0900776#ifdef CONFIG_ATA_ACPI
777 acpi_handle acpi_handle;
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900778 struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
Tejun Heofafbae82007-05-15 03:28:16 +0900779#endif
Tejun Heo84bda122009-03-02 18:53:26 +0900780 /* owned by EH */
781 u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782};
783
Tejun Heo029cfd62008-03-25 12:22:49 +0900784/* The following initializer overrides a method to NULL whether one of
785 * its parent has the method defined or not. This is equivalent to
786 * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
787 * expression and thus can't be used as an initializer.
788 */
789#define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791struct ata_port_operations {
Tejun Heoc1bc8992008-03-25 12:22:47 +0900792 /*
793 * Command execution
794 */
795 int (*qc_defer)(struct ata_queued_cmd *qc);
796 int (*check_atapi_dma)(struct ata_queued_cmd *qc);
797 void (*qc_prep)(struct ata_queued_cmd *qc);
798 unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +0900799 bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Tejun Heoc1bc8992008-03-25 12:22:47 +0900801 /*
802 * Configuration and exception handling
803 */
804 int (*cable_detect)(struct ata_port *ap);
805 unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
806 void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
807 void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
808 int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
Alan Cox963e4972008-07-24 17:16:06 +0100809 unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Tejun Heoc1bc8992008-03-25 12:22:47 +0900811 void (*dev_config)(struct ata_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
Tejun Heoc1bc8992008-03-25 12:22:47 +0900813 void (*freeze)(struct ata_port *ap);
814 void (*thaw)(struct ata_port *ap);
Tejun Heoa1efdab2008-03-25 12:22:50 +0900815 ata_prereset_fn_t prereset;
816 ata_reset_fn_t softreset;
817 ata_reset_fn_t hardreset;
818 ata_postreset_fn_t postreset;
819 ata_prereset_fn_t pmp_prereset;
820 ata_reset_fn_t pmp_softreset;
821 ata_reset_fn_t pmp_hardreset;
822 ata_postreset_fn_t pmp_postreset;
Tejun Heoc1bc8992008-03-25 12:22:47 +0900823 void (*error_handler)(struct ata_port *ap);
Alan Coxc96f1732009-03-24 10:23:46 +0000824 void (*lost_interrupt)(struct ata_port *ap);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900825 void (*post_internal_cmd)(struct ata_queued_cmd *qc);
826
827 /*
828 * Optional features
829 */
Tejun Heo82ef04f2008-07-31 17:02:40 +0900830 int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
831 int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900832 void (*pmp_attach)(struct ata_port *ap);
833 void (*pmp_detach)(struct ata_port *ap);
834 int (*enable_pm)(struct ata_port *ap, enum link_pm policy);
835 void (*disable_pm)(struct ata_port *ap);
836
837 /*
838 * Start, stop, suspend and resume
839 */
840 int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
841 int (*port_resume)(struct ata_port *ap);
842 int (*port_start)(struct ata_port *ap);
843 void (*port_stop)(struct ata_port *ap);
844 void (*host_stop)(struct ata_host *host);
845
Tejun Heo127102a2008-04-07 22:47:21 +0900846#ifdef CONFIG_ATA_SFF
Tejun Heoc1bc8992008-03-25 12:22:47 +0900847 /*
848 * SFF / taskfile oriented ops
849 */
Tejun Heo5682ed32008-04-07 22:47:16 +0900850 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
851 u8 (*sff_check_status)(struct ata_port *ap);
852 u8 (*sff_check_altstatus)(struct ata_port *ap);
853 void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
854 void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
855 void (*sff_exec_command)(struct ata_port *ap,
856 const struct ata_taskfile *tf);
857 unsigned int (*sff_data_xfer)(struct ata_device *dev,
858 unsigned char *buf, unsigned int buflen, int rw);
859 u8 (*sff_irq_on)(struct ata_port *);
860 void (*sff_irq_clear)(struct ata_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
Tejun Heoc1bc8992008-03-25 12:22:47 +0900862 void (*bmdma_setup)(struct ata_queued_cmd *qc);
863 void (*bmdma_start)(struct ata_queued_cmd *qc);
864 void (*bmdma_stop)(struct ata_queued_cmd *qc);
865 u8 (*bmdma_status)(struct ata_port *ap);
Alan Cox3d47aa82009-03-24 10:23:19 +0000866
867 void (*drain_fifo)(struct ata_queued_cmd *qc);
Tejun Heo127102a2008-04-07 22:47:21 +0900868#endif /* CONFIG_ATA_SFF */
Tejun Heoc19ba8a2006-01-24 17:05:22 +0900869
Kristen Carlson Accardi18f7ba42008-06-03 10:33:55 -0700870 ssize_t (*em_show)(struct ata_port *ap, char *buf);
871 ssize_t (*em_store)(struct ata_port *ap, const char *message,
872 size_t size);
873 ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
874 ssize_t (*sw_activity_store)(struct ata_device *dev,
875 enum sw_activity val);
Tejun Heoc1bc8992008-03-25 12:22:47 +0900876 /*
877 * Obsolete
Tejun Heo9ec957f2006-05-15 20:57:58 +0900878 */
Tejun Heoc1bc8992008-03-25 12:22:47 +0900879 void (*phy_reset)(struct ata_port *ap);
880 void (*eng_timeout)(struct ata_port *ap);
Tejun Heo029cfd62008-03-25 12:22:49 +0900881
882 /*
883 * ->inherits must be the last field and all the preceding
884 * fields must be pointers.
885 */
886 const struct ata_port_operations *inherits;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887};
888
889struct ata_port_info {
Jeff Garzikcca39742006-08-24 03:19:22 -0400890 unsigned long flags;
Tejun Heo0c887582007-08-06 18:36:23 +0900891 unsigned long link_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 unsigned long pio_mask;
893 unsigned long mwdma_mask;
894 unsigned long udma_mask;
Tejun Heo029cfd62008-03-25 12:22:49 +0900895 struct ata_port_operations *port_ops;
Alan Coxe99f8b52005-11-08 14:09:44 +0000896 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897};
898
Alan Cox452503f2005-10-21 19:01:32 -0400899struct ata_timing {
900 unsigned short mode; /* ATA mode */
901 unsigned short setup; /* t1 */
902 unsigned short act8b; /* t2 for 8-bit I/O */
903 unsigned short rec8b; /* t2i for 8-bit I/O */
904 unsigned short cyc8b; /* t0 for 8-bit I/O */
905 unsigned short active; /* t2 or tD */
906 unsigned short recover; /* t2i or tK */
David Daney3ada9c12009-01-15 17:45:31 -0800907 unsigned short dmack_hold; /* tj */
Alan Cox452503f2005-10-21 19:01:32 -0400908 unsigned short cycle; /* t0 */
909 unsigned short udma; /* t2CYCTYP/2 */
910};
911
Tejun Heo624d5c52008-03-25 22:16:41 +0900912/*
913 * Core layer - drivers/ata/libata-core.c
914 */
Tejun Heoe9c83912006-07-03 16:07:26 +0900915extern const unsigned long sata_deb_timing_normal[];
916extern const unsigned long sata_deb_timing_hotplug[];
917extern const unsigned long sata_deb_timing_long[];
918
Tejun Heo029cfd62008-03-25 12:22:49 +0900919extern struct ata_port_operations ata_dummy_port_ops;
Tejun Heo21b0ad42007-04-17 23:44:07 +0900920extern const struct ata_port_info ata_dummy_port_info;
Tejun Heodd5b06c2006-08-10 16:59:12 +0900921
Tejun Heoe9c83912006-07-03 16:07:26 +0900922static inline const unsigned long *
923sata_ehc_deb_timing(struct ata_eh_context *ehc)
924{
925 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
926 return sata_deb_timing_hotplug;
927 else
928 return sata_deb_timing_normal;
929}
Tejun Heod7bb4cc2006-05-31 18:27:46 +0900930
Tejun Heodd5b06c2006-08-10 16:59:12 +0900931static inline int ata_port_is_dummy(struct ata_port *ap)
932{
933 return ap->ops == &ata_dummy_port_ops;
934}
935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936extern void ata_port_probe(struct ata_port *);
Tejun Heo936fd732007-08-06 18:36:23 +0900937extern int sata_set_spd(struct ata_link *link);
Tejun Heo0aa11132008-04-07 22:47:18 +0900938extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
Tejun Heoaa2731a2008-04-07 22:47:19 +0900939extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
940 int (*check_ready)(struct ata_link *link));
Tejun Heo936fd732007-08-06 18:36:23 +0900941extern int sata_link_debounce(struct ata_link *link,
942 const unsigned long *params, unsigned long deadline);
943extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
944 unsigned long deadline);
Tejun Heocc0680a2007-08-06 18:36:23 +0900945extern int sata_link_hardreset(struct ata_link *link,
Tejun Heo9dadd452008-04-07 22:47:19 +0900946 const unsigned long *timing, unsigned long deadline,
947 bool *online, int (*check_ready)(struct ata_link *));
Tejun Heo57c9efd2008-04-07 22:47:19 +0900948extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
949 unsigned long deadline);
Tejun Heo203c75b2008-04-07 22:47:18 +0900950extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951extern void ata_port_disable(struct ata_port *);
Jeff Garzik28555682007-10-11 17:12:35 -0400952
Tejun Heof3187192007-04-17 23:44:07 +0900953extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
Tejun Heof5cda252007-04-17 23:44:07 +0900954extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
955 const struct ata_port_info * const * ppi, int n_ports);
Tejun Heob1c72912008-07-31 17:02:43 +0900956extern int ata_slave_link_init(struct ata_port *ap);
Tejun Heoecef7252007-04-17 23:44:06 +0900957extern int ata_host_start(struct ata_host *host);
Tejun Heof3187192007-04-17 23:44:07 +0900958extern int ata_host_register(struct ata_host *host,
959 struct scsi_host_template *sht);
Tejun Heof5cda252007-04-17 23:44:07 +0900960extern int ata_host_activate(struct ata_host *host, int irq,
961 irq_handler_t irq_handler, unsigned long irq_flags,
962 struct scsi_host_template *sht);
Tejun Heo0529c152007-01-20 16:00:26 +0900963extern void ata_host_detach(struct ata_host *host);
Jeff Garzikcca39742006-08-24 03:19:22 -0400964extern void ata_host_init(struct ata_host *, struct device *,
Tejun Heo029cfd62008-03-25 12:22:49 +0900965 unsigned long, struct ata_port_operations *);
Jeff Garzik193515d2005-11-07 00:59:37 -0500966extern int ata_scsi_detect(struct scsi_host_template *sht);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
968extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
Jeff Garzik94be9a52009-01-16 10:17:09 -0500969extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
970 int cmd, void __user *arg);
Brian King80289162006-08-07 14:27:31 -0500971extern void ata_sas_port_destroy(struct ata_port *);
Jeff Garzikcca39742006-08-24 03:19:22 -0400972extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
Brian King80289162006-08-07 14:27:31 -0500973 struct ata_port_info *, struct Scsi_Host *);
974extern int ata_sas_port_init(struct ata_port *);
975extern int ata_sas_port_start(struct ata_port *ap);
976extern void ata_sas_port_stop(struct ata_port *ap);
977extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
978extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
979 struct ata_port *ap);
Tejun Heo936fd732007-08-06 18:36:23 +0900980extern int sata_scr_valid(struct ata_link *link);
981extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
982extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
983extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
Tejun Heob5b3fa32008-07-31 17:02:42 +0900984extern bool ata_link_online(struct ata_link *link);
985extern bool ata_link_offline(struct ata_link *link);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900986#ifdef CONFIG_PM
Jeff Garzikcca39742006-08-24 03:19:22 -0400987extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
988extern void ata_host_resume(struct ata_host *host);
Tejun Heo6ffa01d2007-03-02 17:32:47 +0900989#endif
Jeff Garzik67846b32005-10-05 02:58:32 -0400990extern int ata_ratelimit(void);
Tejun Heoc22daff2006-04-11 22:22:29 +0900991extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
Tejun Heo341c2c92008-05-20 02:17:51 +0900992 unsigned long interval, unsigned long timeout);
Tejun Heo436d34b2008-04-02 17:28:46 +0900993extern int atapi_cmd_type(u8 opcode);
Tejun Heo99771262007-07-16 14:29:38 +0900994extern void ata_tf_to_fis(const struct ata_taskfile *tf,
995 u8 pmp, int is_cmd, u8 *fis);
Jeff Garzik057ace52005-10-22 14:27:05 -0400996extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
Tejun Heo7dc951a2007-11-27 19:43:42 +0900997extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
998 unsigned long mwdma_mask, unsigned long udma_mask);
999extern void ata_unpack_xfermask(unsigned long xfer_mask,
1000 unsigned long *pio_mask, unsigned long *mwdma_mask,
1001 unsigned long *udma_mask);
1002extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1003extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1004extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1005extern const char *ata_mode_string(unsigned long xfer_mask);
1006extern unsigned long ata_id_xfermask(const u16 *id);
Jeff Garzik2dcb4072007-10-19 06:42:56 -04001007extern int ata_port_start(struct ata_port *ap);
Tejun Heo31cc23b2007-09-23 13:14:12 +09001008extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
Brian Kinge46834c2006-03-17 17:04:03 -06001009extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1011 unsigned int n_elem);
Jeff Garzik057ace52005-10-22 14:27:05 -04001012extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
Alan10305f02007-02-20 18:01:59 +00001013extern void ata_dev_disable(struct ata_device *adev);
Tejun Heo6a62a042006-02-13 10:02:46 +09001014extern void ata_id_string(const u16 *id, unsigned char *s,
1015 unsigned int ofs, unsigned int len);
1016extern void ata_id_c_string(const u16 *id, unsigned char *s,
1017 unsigned int ofs, unsigned int len);
Alan Cox963e4972008-07-24 17:16:06 +01001018extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1019 struct ata_taskfile *tf, u16 *id);
Tejun Heof686bcb2006-05-15 20:58:05 +09001020extern void ata_qc_complete(struct ata_queued_cmd *qc);
Tejun Heo79f97da2008-04-07 22:47:20 +09001021extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
Tejun Heo3373efd2006-05-15 20:57:53 +09001022extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 void (*done)(struct scsi_cmnd *));
1024extern int ata_std_bios_param(struct scsi_device *sdev,
1025 struct block_device *bdev,
1026 sector_t capacity, int geom[]);
1027extern int ata_scsi_slave_config(struct scsi_device *sdev);
Tejun Heo83c47bc2006-05-31 18:28:07 +09001028extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
Tejun Heoa6e6ce82006-05-15 21:03:48 +09001029extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
Mike Christiee881a172009-10-15 17:46:39 -07001030 int queue_depth, int reason);
Tejun Heo3373efd2006-05-15 20:57:53 +09001031extern struct ata_device *ata_dev_pair(struct ata_device *adev);
Tejun Heo02607312007-08-06 18:36:23 +09001032extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
Alan Coxbe0d18d2007-03-06 02:37:56 -08001034extern int ata_cable_40wire(struct ata_port *ap);
1035extern int ata_cable_80wire(struct ata_port *ap);
1036extern int ata_cable_sata(struct ata_port *ap);
Tejun Heoc88f90c2007-11-27 19:43:48 +09001037extern int ata_cable_ignore(struct ata_port *ap);
Alan Coxbe0d18d2007-03-06 02:37:56 -08001038extern int ata_cable_unknown(struct ata_port *ap);
1039
Mark Lord1a660162009-02-25 15:18:32 -05001040extern void ata_pio_queue_task(struct ata_port *ap, void *data,
1041 unsigned long delay);
1042
Tejun Heo624d5c52008-03-25 22:16:41 +09001043/* Timing helpers */
Alan Cox1bc4ccf2006-01-09 17:18:14 +00001044extern unsigned int ata_pio_need_iordy(const struct ata_device *);
Tejun Heo63573572007-11-27 19:43:39 +09001045extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
Alan Cox452503f2005-10-21 19:01:32 -04001046extern int ata_timing_compute(struct ata_device *, unsigned short,
1047 struct ata_timing *, int, int);
1048extern void ata_timing_merge(const struct ata_timing *,
1049 const struct ata_timing *, struct ata_timing *,
1050 unsigned int);
Tejun Heoa0f79b92007-12-18 16:33:05 +09001051extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
Alan Cox452503f2005-10-21 19:01:32 -04001052
Tejun Heo624d5c52008-03-25 22:16:41 +09001053/* PCI */
1054#ifdef CONFIG_PCI
1055struct pci_dev;
1056
1057struct pci_bits {
1058 unsigned int reg; /* PCI config register to read */
1059 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1060 unsigned long mask;
1061 unsigned long val;
Alan Cox452503f2005-10-21 19:01:32 -04001062};
1063
Tejun Heo624d5c52008-03-25 22:16:41 +09001064extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1065extern void ata_pci_remove_one(struct pci_dev *pdev);
1066
1067#ifdef CONFIG_PM
1068extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1069extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1070extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1071extern int ata_pci_device_resume(struct pci_dev *pdev);
1072#endif /* CONFIG_PM */
1073#endif /* CONFIG_PCI */
1074
1075/*
1076 * ACPI - drivers/ata/libata-acpi.c
1077 */
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001078#ifdef CONFIG_ATA_ACPI
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001079static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1080{
1081 if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1082 return &ap->__acpi_init_gtm;
1083 return NULL;
1084}
Tejun Heo0d02f0b2007-12-15 15:04:57 +09001085int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1086int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
Tejun Heo7c77fa42007-12-18 16:33:03 +09001087unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1088 const struct ata_acpi_gtm *gtm);
Tejun Heo021ee9a2007-12-18 16:33:06 +09001089int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001090#else
Tejun Heoc05e6ff2007-12-15 15:05:02 +09001091static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1092{
1093 return NULL;
1094}
Tejun Heo7c77fa42007-12-18 16:33:03 +09001095
1096static inline int ata_acpi_stm(const struct ata_port *ap,
1097 struct ata_acpi_gtm *stm)
1098{
1099 return -ENOSYS;
1100}
1101
1102static inline int ata_acpi_gtm(const struct ata_port *ap,
1103 struct ata_acpi_gtm *stm)
1104{
1105 return -ENOSYS;
1106}
1107
1108static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1109 const struct ata_acpi_gtm *gtm)
1110{
1111 return 0;
1112}
Tejun Heo021ee9a2007-12-18 16:33:06 +09001113
1114static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1115 const struct ata_acpi_gtm *gtm)
1116{
1117 return 0;
1118}
Alan Coxe1ddb4b2007-08-16 02:33:36 -04001119#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
Tejun Heoece1d632006-04-02 18:51:53 +09001121/*
Tejun Heo624d5c52008-03-25 22:16:41 +09001122 * EH - drivers/ata/libata-eh.c
Tejun Heoece1d632006-04-02 18:51:53 +09001123 */
Tejun Heo7b70fc02006-05-15 20:58:07 +09001124extern void ata_port_schedule_eh(struct ata_port *ap);
Tejun Heodbd82612007-08-06 18:36:23 +09001125extern int ata_link_abort(struct ata_link *link);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001126extern int ata_port_abort(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001127extern int ata_port_freeze(struct ata_port *ap);
Tejun Heo7d77b242007-09-23 13:14:13 +09001128extern int sata_async_notification(struct ata_port *ap);
Tejun Heoe3180492006-05-15 20:58:09 +09001129
1130extern void ata_eh_freeze_port(struct ata_port *ap);
1131extern void ata_eh_thaw_port(struct ata_port *ap);
Tejun Heo7b70fc02006-05-15 20:58:07 +09001132
Tejun Heoece1d632006-04-02 18:51:53 +09001133extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1134extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
Mark Lord10acf3b2008-05-02 02:14:53 -04001135extern void ata_eh_analyze_ncq_error(struct ata_link *link);
Tejun Heoece1d632006-04-02 18:51:53 +09001136
Tejun Heof5914a42006-05-31 18:27:48 +09001137extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1138 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1139 ata_postreset_fn_t postreset);
Tejun Heoa1efdab2008-03-25 12:22:50 +09001140extern void ata_std_error_handler(struct ata_port *ap);
Tejun Heo022bdb02006-05-15 20:58:22 +09001141
Tejun Heo61440db2006-05-15 20:57:55 +09001142/*
Tejun Heo68d1d072008-03-25 12:22:49 +09001143 * Base operations to inherit from and initializers for sht
1144 *
1145 * Operations
1146 *
1147 * base : Common to all libata drivers.
1148 * sata : SATA controllers w/ native interface.
1149 * pmp : SATA controllers w/ PMP support.
1150 * sff : SFF ATA controllers w/o BMDMA support.
1151 * bmdma : SFF ATA controllers w/ BMDMA support.
1152 *
1153 * sht initializers
1154 *
1155 * BASE : Common to all libata drivers. The user must set
1156 * sg_tablesize and dma_boundary.
1157 * PIO : SFF ATA controllers w/ only PIO support.
1158 * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
1159 * dma_boundary are set to BMDMA limits.
1160 * NCQ : SATA controllers supporting NCQ. The user must set
1161 * sg_tablesize, dma_boundary and can_queue.
1162 */
1163extern const struct ata_port_operations ata_base_port_ops;
1164extern const struct ata_port_operations sata_port_ops;
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001165extern struct device_attribute *ata_common_sdev_attrs[];
Tejun Heo68d1d072008-03-25 12:22:49 +09001166
1167#define ATA_BASE_SHT(drv_name) \
1168 .module = THIS_MODULE, \
1169 .name = drv_name, \
1170 .ioctl = ata_scsi_ioctl, \
1171 .queuecommand = ata_scsi_queuecmd, \
1172 .can_queue = ATA_DEF_QUEUE, \
1173 .this_id = ATA_SHT_THIS_ID, \
1174 .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
1175 .emulated = ATA_SHT_EMULATED, \
1176 .use_clustering = ATA_SHT_USE_CLUSTERING, \
1177 .proc_name = drv_name, \
1178 .slave_configure = ata_scsi_slave_config, \
1179 .slave_destroy = ata_scsi_slave_destroy, \
Elias Oltmanns45fabbb2008-09-21 11:54:08 +02001180 .bios_param = ata_std_bios_param, \
1181 .sdev_attrs = ata_common_sdev_attrs
Tejun Heo68d1d072008-03-25 12:22:49 +09001182
Tejun Heo68d1d072008-03-25 12:22:49 +09001183#define ATA_NCQ_SHT(drv_name) \
1184 ATA_BASE_SHT(drv_name), \
1185 .change_queue_depth = ata_scsi_change_queue_depth
1186
1187/*
Tejun Heo071f44b2008-04-07 22:47:22 +09001188 * PMP helpers
1189 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001190#ifdef CONFIG_SATA_PMP
Tejun Heo071f44b2008-04-07 22:47:22 +09001191static inline bool sata_pmp_supported(struct ata_port *ap)
1192{
1193 return ap->flags & ATA_FLAG_PMP;
1194}
1195
1196static inline bool sata_pmp_attached(struct ata_port *ap)
1197{
1198 return ap->nr_pmp_links != 0;
1199}
1200
1201static inline int ata_is_host_link(const struct ata_link *link)
1202{
Tejun Heob1c72912008-07-31 17:02:43 +09001203 return link == &link->ap->link || link == link->ap->slave_link;
Tejun Heo071f44b2008-04-07 22:47:22 +09001204}
Tejun Heo88fcd562008-04-07 22:47:22 +09001205#else /* CONFIG_SATA_PMP */
1206static inline bool sata_pmp_supported(struct ata_port *ap)
1207{
1208 return false;
1209}
1210
1211static inline bool sata_pmp_attached(struct ata_port *ap)
1212{
1213 return false;
1214}
1215
1216static inline int ata_is_host_link(const struct ata_link *link)
1217{
1218 return 1;
1219}
1220#endif /* CONFIG_SATA_PMP */
Tejun Heo071f44b2008-04-07 22:47:22 +09001221
1222static inline int sata_srst_pmp(struct ata_link *link)
1223{
1224 if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1225 return SATA_PMP_CTRL_PORT;
1226 return link->pmp;
1227}
1228
1229/*
Tejun Heo61440db2006-05-15 20:57:55 +09001230 * printk helpers
1231 */
1232#define ata_port_printk(ap, lv, fmt, args...) \
Tejun Heoc2e366a2007-12-15 15:04:58 +09001233 printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Tejun Heo89898052007-08-06 18:36:23 +09001235#define ata_link_printk(link, lv, fmt, args...) do { \
Tejun Heob1c72912008-07-31 17:02:43 +09001236 if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link) \
Tejun Heoc2e366a2007-12-15 15:04:58 +09001237 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
Tejun Heo89898052007-08-06 18:36:23 +09001238 (link)->pmp , ##args); \
1239 else \
Tejun Heoc2e366a2007-12-15 15:04:58 +09001240 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
Tejun Heo89898052007-08-06 18:36:23 +09001241 } while(0)
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001242
Tejun Heo61440db2006-05-15 20:57:55 +09001243#define ata_dev_printk(dev, lv, fmt, args...) \
Tejun Heoc2e366a2007-12-15 15:04:58 +09001244 printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
Tejun Heo89898052007-08-06 18:36:23 +09001245 (dev)->link->pmp + (dev)->devno , ##args)
Tejun Heo61440db2006-05-15 20:57:55 +09001246
1247/*
Tejun Heof3e81b12006-05-15 20:58:21 +09001248 * ata_eh_info helpers
1249 */
Tejun Heocb94c1c2007-07-30 14:24:15 +09001250extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1251 __attribute__ ((format (printf, 2, 3)));
1252extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1253 __attribute__ ((format (printf, 2, 3)));
Tejun Heob64bbc32007-07-16 14:29:39 +09001254extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
Tejun Heof3e81b12006-05-15 20:58:21 +09001255
Tejun Heoc0b6c032006-07-03 16:07:26 +09001256static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1257{
Tejun Heob558edd2008-01-24 00:05:14 +09001258 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
Tejun Heof8f1e1c2007-07-16 14:29:40 +09001259 ehi->flags |= ATA_EHI_HOTPLUGGED;
Tejun Heob558edd2008-01-24 00:05:14 +09001260 ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
Tejun Heoc0b6c032006-07-03 16:07:26 +09001261 ehi->err_mask |= AC_ERR_ATA_BUS;
1262}
1263
Tejun Heof3e81b12006-05-15 20:58:21 +09001264/*
Tejun Heocbcdd872007-08-18 13:14:55 +09001265 * port description helpers
1266 */
1267extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1268 __attribute__ ((format (printf, 2, 3)));
1269#ifdef CONFIG_PCI
1270extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1271 const char *name);
1272#endif
1273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274static inline unsigned int ata_tag_valid(unsigned int tag)
1275{
1276 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1277}
1278
Tejun Heo2ab7db12006-05-15 20:58:02 +09001279static inline unsigned int ata_tag_internal(unsigned int tag)
1280{
Yoichi Yuasa83c063d2008-02-28 21:43:13 +09001281 return tag == ATA_TAG_INTERNAL;
Tejun Heo2ab7db12006-05-15 20:58:02 +09001282}
1283
Tejun Heo5806db22006-06-24 20:30:19 +09001284/*
1285 * device helpers
1286 */
Tejun Heoe1211e32006-04-01 01:38:18 +09001287static inline unsigned int ata_class_enabled(unsigned int class)
Tejun Heo597afd22006-03-01 01:25:38 +09001288{
Tejun Heoe0a71752007-09-23 13:14:12 +09001289 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1290 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
Tejun Heo597afd22006-03-01 01:25:38 +09001291}
1292
Tejun Heoe1211e32006-04-01 01:38:18 +09001293static inline unsigned int ata_class_disabled(unsigned int class)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294{
Tejun Heoe0a71752007-09-23 13:14:12 +09001295 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1296 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
Tejun Heoe1211e32006-04-01 01:38:18 +09001297}
1298
Tejun Heo002c8052006-04-02 17:54:46 +09001299static inline unsigned int ata_class_absent(unsigned int class)
1300{
1301 return !ata_class_enabled(class) && !ata_class_disabled(class);
1302}
1303
Tejun Heoe1211e32006-04-01 01:38:18 +09001304static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1305{
1306 return ata_class_enabled(dev->class);
1307}
1308
1309static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1310{
1311 return ata_class_disabled(dev->class);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312}
1313
Tejun Heo002c8052006-04-02 17:54:46 +09001314static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1315{
1316 return ata_class_absent(dev->class);
1317}
1318
Tejun Heo5806db22006-06-24 20:30:19 +09001319/*
Tejun Heof58229f2007-08-06 18:36:23 +09001320 * link helpers
Tejun Heo5806db22006-06-24 20:30:19 +09001321 */
Tejun Heof58229f2007-08-06 18:36:23 +09001322static inline int ata_link_max_devices(const struct ata_link *link)
Tejun Heo5806db22006-06-24 20:30:19 +09001323{
Tejun Heo89898052007-08-06 18:36:23 +09001324 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
Tejun Heo5806db22006-06-24 20:30:19 +09001325 return 2;
1326 return 1;
1327}
1328
Tejun Heoda917d62007-09-23 13:14:12 +09001329static inline int ata_link_active(struct ata_link *link)
1330{
1331 return ata_tag_valid(link->active_tag) || link->sactive;
1332}
1333
Tejun Heo1eca4362008-11-03 20:03:17 +09001334/*
1335 * Iterators
1336 *
1337 * ATA_LITER_* constants are used to select link iteration mode and
1338 * ATA_DITER_* device iteration mode.
1339 *
1340 * For a custom iteration directly using ata_{link|dev}_next(), if
1341 * @link or @dev, respectively, is NULL, the first element is
1342 * returned. @dev and @link can be any valid device or link and the
1343 * next element according to the iteration mode will be returned.
1344 * After the last element, NULL is returned.
1345 */
1346enum ata_link_iter_mode {
1347 ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
1348 * host link. no slave link */
1349 ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
1350 ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
1351 * slave link still comes after host link */
1352};
Tejun Heo89898052007-08-06 18:36:23 +09001353
Tejun Heo1eca4362008-11-03 20:03:17 +09001354enum ata_dev_iter_mode {
1355 ATA_DITER_ENABLED,
1356 ATA_DITER_ENABLED_REVERSE,
1357 ATA_DITER_ALL,
1358 ATA_DITER_ALL_REVERSE,
1359};
Tejun Heo89898052007-08-06 18:36:23 +09001360
Tejun Heo1eca4362008-11-03 20:03:17 +09001361extern struct ata_link *ata_link_next(struct ata_link *link,
1362 struct ata_port *ap,
1363 enum ata_link_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001364
Tejun Heo1eca4362008-11-03 20:03:17 +09001365extern struct ata_device *ata_dev_next(struct ata_device *dev,
1366 struct ata_link *link,
1367 enum ata_dev_iter_mode mode);
Tejun Heof58229f2007-08-06 18:36:23 +09001368
Tejun Heo1eca4362008-11-03 20:03:17 +09001369/*
1370 * Shortcut notation for iterations
1371 *
1372 * ata_for_each_link() iterates over each link of @ap according to
1373 * @mode. @link points to the current link in the loop. @link is
1374 * NULL after loop termination. ata_for_each_dev() works the same way
1375 * except that it iterates over each device of @link.
1376 *
1377 * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1378 * specified when using the following shorthand notations. Only the
1379 * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1380 * specified. This not only increases brevity but also makes it
1381 * impossible to use ATA_LITER_* for device iteration or vice-versa.
1382 */
1383#define ata_for_each_link(link, ap, mode) \
1384 for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1385 (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1386
1387#define ata_for_each_dev(dev, link, mode) \
1388 for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1389 (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
Tejun Heo5806db22006-06-24 20:30:19 +09001390
Tejun Heo6d1245b2007-02-20 23:20:27 +09001391/**
1392 * ata_ncq_enabled - Test whether NCQ is enabled
1393 * @dev: ATA device to test for
1394 *
1395 * LOCKING:
1396 * spin_lock_irqsave(host lock)
1397 *
1398 * RETURNS:
1399 * 1 if NCQ is enabled for @dev, 0 otherwise.
1400 */
1401static inline int ata_ncq_enabled(struct ata_device *dev)
1402{
1403 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1404 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1405}
Edward Falk0baab862005-06-02 18:17:13 -04001406
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1408{
1409 qc->tf.ctl |= ATA_NIEN;
1410}
1411
Tejun Heof69499f2006-05-15 20:58:03 +09001412static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1413 unsigned int tag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414{
1415 if (likely(ata_tag_valid(tag)))
1416 return &ap->qcmd[tag];
1417 return NULL;
1418}
1419
Tejun Heof69499f2006-05-15 20:58:03 +09001420static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1421 unsigned int tag)
1422{
1423 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1424
1425 if (unlikely(!qc) || !ap->ops->error_handler)
1426 return qc;
1427
1428 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1429 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1430 return qc;
1431
1432 return NULL;
1433}
1434
Tejun Heoaacda372008-03-18 17:47:43 +09001435static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1436{
1437 return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1438}
1439
Tejun Heo3373efd2006-05-15 20:57:53 +09001440static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441{
1442 memset(tf, 0, sizeof(*tf));
1443
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001444 tf->ctl = dev->link->ap->ctl;
Tejun Heo3373efd2006-05-15 20:57:53 +09001445 if (dev->devno == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 tf->device = ATA_DEVICE_OBS;
1447 else
1448 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1449}
1450
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001451static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1452{
Tejun Heo501e0c52007-01-17 11:34:02 +09001453 qc->dma_dir = DMA_NONE;
Tejun Heoff2aeb12007-12-05 16:43:11 +09001454 qc->sg = NULL;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001455 qc->flags = 0;
Jens Axboe87260212007-10-16 11:14:12 +02001456 qc->cursg = NULL;
1457 qc->cursg_ofs = 0;
Tejun Heoaacda372008-03-18 17:47:43 +09001458 qc->nbytes = qc->extrabytes = qc->curbytes = 0;
Brian King7a801182007-01-17 12:32:12 -06001459 qc->n_elem = 0;
Albert Leea22e2eb2005-12-05 15:38:02 +08001460 qc->err_mask = 0;
Mark Lord5a5dbd12007-03-16 10:22:26 -04001461 qc->sect_size = ATA_SECT_SIZE;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001462
Tejun Heo3373efd2006-05-15 20:57:53 +09001463 ata_tf_init(qc->dev, &qc->tf);
Tejun Heoe61e0672006-05-15 20:57:40 +09001464
1465 /* init result_tf such that it indicates normal completion */
1466 qc->result_tf.command = ATA_DRDY;
1467 qc->result_tf.feature = 0;
Jeff Garzik2c13b7c2005-11-14 14:14:16 -05001468}
1469
Jeff Garzik057ace52005-10-22 14:27:05 -04001470static inline int ata_try_flush_cache(const struct ata_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471{
1472 return ata_id_wcache_enabled(dev->id) ||
1473 ata_id_has_flush(dev->id) ||
1474 ata_id_has_flush_ext(dev->id);
1475}
1476
Jeff Garzika7dac442005-10-30 04:44:42 -05001477static inline unsigned int ac_err_mask(u8 status)
1478{
Albert Lee3655d1d2006-05-19 11:43:04 +08001479 if (status & (ATA_BUSY | ATA_DRQ))
Tejun Heo11a56d22006-01-23 13:09:36 +09001480 return AC_ERR_HSM;
Jeff Garzika7dac442005-10-30 04:44:42 -05001481 if (status & (ATA_ERR | ATA_DF))
1482 return AC_ERR_DEV;
1483 return 0;
1484}
1485
1486static inline unsigned int __ac_err_mask(u8 status)
1487{
1488 unsigned int mask = ac_err_mask(status);
1489 if (mask == 0)
1490 return AC_ERR_OTHER;
1491 return mask;
1492}
1493
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001494static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1495{
Tejun Heo49114872007-04-17 23:44:06 +09001496 return *(struct ata_port **)&host->hostdata[0];
Jeff Garzik35bb94b2006-04-11 13:12:34 -04001497}
1498
Tejun Heo78ab88f2008-05-01 23:41:41 +09001499static inline int ata_check_ready(u8 status)
1500{
Jeff Garzik005b1f72008-05-09 15:00:55 -04001501 if (!(status & ATA_BUSY))
1502 return 1;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001503
1504 /* 0xff indicates either no device or device not ready */
1505 if (status == 0xff)
1506 return -ENODEV;
1507
Jeff Garzik005b1f72008-05-09 15:00:55 -04001508 return 0;
Tejun Heo78ab88f2008-05-01 23:41:41 +09001509}
1510
Tejun Heo341c2c92008-05-20 02:17:51 +09001511static inline unsigned long ata_deadline(unsigned long from_jiffies,
1512 unsigned long timeout_msecs)
1513{
1514 return from_jiffies + msecs_to_jiffies(timeout_msecs);
1515}
1516
Alan Coxb15b3eb2008-08-01 09:18:34 +01001517/* Don't open code these in drivers as there are traps. Firstly the range may
1518 change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1519 > UDMA_0. Dyma ddreigiau */
1520
1521static inline int ata_using_mwdma(struct ata_device *adev)
1522{
1523 if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1524 return 1;
1525 return 0;
1526}
1527
1528static inline int ata_using_udma(struct ata_device *adev)
1529{
1530 if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1531 return 1;
1532 return 0;
1533}
1534
1535static inline int ata_dma_enabled(struct ata_device *adev)
1536{
1537 return (adev->dma_mode == 0xFF ? 0 : 1);
1538}
Tejun Heo48515f62008-04-07 22:47:21 +09001539
1540/**************************************************************************
1541 * PMP - drivers/ata/libata-pmp.c
1542 */
Tejun Heo88fcd562008-04-07 22:47:22 +09001543#ifdef CONFIG_SATA_PMP
1544
Tejun Heo48515f62008-04-07 22:47:21 +09001545extern const struct ata_port_operations sata_pmp_port_ops;
1546
1547extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1548extern void sata_pmp_error_handler(struct ata_port *ap);
1549
Tejun Heo88fcd562008-04-07 22:47:22 +09001550#else /* CONFIG_SATA_PMP */
1551
1552#define sata_pmp_port_ops sata_port_ops
1553#define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
1554#define sata_pmp_error_handler ata_std_error_handler
1555
1556#endif /* CONFIG_SATA_PMP */
1557
Tejun Heo48515f62008-04-07 22:47:21 +09001558
Tejun Heo624d5c52008-03-25 22:16:41 +09001559/**************************************************************************
1560 * SFF - drivers/ata/libata-sff.c
1561 */
Tejun Heo127102a2008-04-07 22:47:21 +09001562#ifdef CONFIG_ATA_SFF
1563
Tejun Heo624d5c52008-03-25 22:16:41 +09001564extern const struct ata_port_operations ata_sff_port_ops;
1565extern const struct ata_port_operations ata_bmdma_port_ops;
Alan Cox871af122009-01-05 14:16:39 +00001566extern const struct ata_port_operations ata_bmdma32_port_ops;
Tejun Heo624d5c52008-03-25 22:16:41 +09001567
1568/* PIO only, sg_tablesize and dma_boundary limits can be removed */
1569#define ATA_PIO_SHT(drv_name) \
1570 ATA_BASE_SHT(drv_name), \
1571 .sg_tablesize = LIBATA_MAX_PRD, \
1572 .dma_boundary = ATA_DMA_BOUNDARY
1573
1574#define ATA_BMDMA_SHT(drv_name) \
1575 ATA_BASE_SHT(drv_name), \
1576 .sg_tablesize = LIBATA_MAX_PRD, \
1577 .dma_boundary = ATA_DMA_BOUNDARY
1578
Tejun Heo9363c382008-04-07 22:47:16 +09001579extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1580extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1581extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1582extern u8 ata_sff_check_status(struct ata_port *ap);
Alan Coxa57c1ba2008-05-29 22:10:58 +01001583extern void ata_sff_pause(struct ata_port *ap);
1584extern void ata_sff_dma_pause(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001585extern int ata_sff_busy_sleep(struct ata_port *ap,
1586 unsigned long timeout_pat, unsigned long timeout);
Tejun Heo705e76b2008-04-07 22:47:19 +09001587extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001588extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1589extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1590extern void ata_sff_exec_command(struct ata_port *ap,
1591 const struct ata_taskfile *tf);
1592extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001593 unsigned char *buf, unsigned int buflen, int rw);
Alan Cox871af122009-01-05 14:16:39 +00001594extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1595 unsigned char *buf, unsigned int buflen, int rw);
Tejun Heo9363c382008-04-07 22:47:16 +09001596extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001597 unsigned char *buf, unsigned int buflen, int rw);
Tejun Heo9363c382008-04-07 22:47:16 +09001598extern u8 ata_sff_irq_on(struct ata_port *ap);
1599extern void ata_sff_irq_clear(struct ata_port *ap);
1600extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1601 u8 status, int in_wq);
1602extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
Tejun Heo22183bf2008-04-07 22:47:20 +09001603extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
Tejun Heo9363c382008-04-07 22:47:16 +09001604extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1605 struct ata_queued_cmd *qc);
1606extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
Alan Coxc96f1732009-03-24 10:23:46 +00001607extern void ata_sff_lost_interrupt(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001608extern void ata_sff_freeze(struct ata_port *ap);
1609extern void ata_sff_thaw(struct ata_port *ap);
1610extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1611extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1612 u8 *r_err);
Tejun Heo705e76b2008-04-07 22:47:19 +09001613extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1614 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001615extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
Tejun Heo624d5c52008-03-25 22:16:41 +09001616 unsigned long deadline);
Tejun Heo9363c382008-04-07 22:47:16 +09001617extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1618 unsigned long deadline);
1619extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
Alan Cox3d47aa82009-03-24 10:23:19 +00001620extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
Tejun Heo9363c382008-04-07 22:47:16 +09001621extern void ata_sff_error_handler(struct ata_port *ap);
1622extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
Tejun Heo624d5c52008-03-25 22:16:41 +09001623extern int ata_sff_port_start(struct ata_port *ap);
Alan Coxe3cf95d2009-04-09 17:31:17 +01001624extern int ata_sff_port_start32(struct ata_port *ap);
Tejun Heo9363c382008-04-07 22:47:16 +09001625extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1626extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1627 unsigned long xfer_mask);
Tejun Heo624d5c52008-03-25 22:16:41 +09001628extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1629extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1630extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1631extern u8 ata_bmdma_status(struct ata_port *ap);
1632extern void ata_bus_reset(struct ata_port *ap);
1633
1634#ifdef CONFIG_PCI
Tejun Heo9363c382008-04-07 22:47:16 +09001635extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1636extern int ata_pci_bmdma_init(struct ata_host *host);
1637extern int ata_pci_sff_init_host(struct ata_host *host);
1638extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
Tejun Heo624d5c52008-03-25 22:16:41 +09001639 const struct ata_port_info * const * ppi,
1640 struct ata_host **r_host);
Tejun Heo9363c382008-04-07 22:47:16 +09001641extern int ata_pci_sff_activate_host(struct ata_host *host,
Tejun Heo624d5c52008-03-25 22:16:41 +09001642 irq_handler_t irq_handler,
1643 struct scsi_host_template *sht);
Tejun Heo9363c382008-04-07 22:47:16 +09001644extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1645 const struct ata_port_info * const * ppi,
1646 struct scsi_host_template *sht, void *host_priv);
Tejun Heo624d5c52008-03-25 22:16:41 +09001647#endif /* CONFIG_PCI */
1648
Tejun Heo624d5c52008-03-25 22:16:41 +09001649/**
Tejun Heo9363c382008-04-07 22:47:16 +09001650 * ata_sff_busy_wait - Wait for a port status register
Tejun Heo624d5c52008-03-25 22:16:41 +09001651 * @ap: Port to wait for.
1652 * @bits: bits that must be clear
1653 * @max: number of 10uS waits to perform
1654 *
1655 * Waits up to max*10 microseconds for the selected bits in the port's
1656 * status register to be cleared.
1657 * Returns final value of status register.
1658 *
1659 * LOCKING:
1660 * Inherited from caller.
1661 */
Tejun Heo9363c382008-04-07 22:47:16 +09001662static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1663 unsigned int max)
Tejun Heo624d5c52008-03-25 22:16:41 +09001664{
1665 u8 status;
1666
1667 do {
1668 udelay(10);
Tejun Heo5682ed32008-04-07 22:47:16 +09001669 status = ap->ops->sff_check_status(ap);
Tejun Heo624d5c52008-03-25 22:16:41 +09001670 max--;
1671 } while (status != 0xff && (status & bits) && (max > 0));
1672
1673 return status;
1674}
1675
1676/**
1677 * ata_wait_idle - Wait for a port to be idle.
1678 * @ap: Port to wait for.
1679 *
1680 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1681 * Returns final value of status register.
1682 *
1683 * LOCKING:
1684 * Inherited from caller.
1685 */
1686static inline u8 ata_wait_idle(struct ata_port *ap)
1687{
Tejun Heo9363c382008-04-07 22:47:16 +09001688 u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
Tejun Heo624d5c52008-03-25 22:16:41 +09001689
1690#ifdef ATA_DEBUG
1691 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1692 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1693 status);
1694#endif
1695
1696 return status;
1697}
Tejun Heo127102a2008-04-07 22:47:21 +09001698#endif /* CONFIG_ATA_SFF */
Tejun Heo624d5c52008-03-25 22:16:41 +09001699
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700#endif /* __LINUX_LIBATA_H__ */